查询路径重写列表

最近更新时间: 2026-10-11 00:12:04

1. 接口描述

接口请求域名： tsf.api3.fincloud.tencent.com。

查询路径重写列表

默认接口请求频率限制：10000次/秒。

接口更新时间：2025-08-06 23:23:55。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribePathRewrites
Version	是	否	String	公共参数，本接口取值：2018-03-26
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
GatewayGroupId	是	否	String	网关部署组ID 示例值：
SearchWord	否	否	String	根据正则表达式或替换的内容模糊查询示例值：
Limit	否	否	Uint64	每页数量示例值：
Offset	否	否	Uint64	起始偏移量示例值：

3. 输出参数

参数名称	类型	描述
Result	PathRewritePage	路径重写翻页对象示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameterValue.GatewayParameterInvalid	无效请求参数:%s。
MissingParameter.GatewayParameterRequired	缺少请求参数:%s。
UnauthorizedOperation.NoPrivilege	用户无权限访问该接口。。

5. 示例

示例1 查询路径重写列表

输入示例

POST / HTTP/1.1
Host: tsf.api3.fincloud.tencent.com
Content-Type: application/json
X-TC-Action: DescribePathRewrites
<Common Parameters>

{
  "GatewayGroupId": "group-yd3b588a",
  "SearchWord": "app",
  "Limit": 10,
  "Offset": 0
}

输出示例

{
  "Response": {
    "RequestId": "a9010490-6c80-4e53-8953-5493d8899460",
    "Result": {
      "Content": [
        {
          "Blocked": "N",
          "GatewayGroupId": "group-yd3b588a",
          "Order": 1,
          "PathRewriteId": "rewrite-2vz5pdwv",
          "Regex": "/app",
          "Replacement": "/user"
        }
      ],
      "TotalCount": 1
    }
  }
}