查询网关所有分组下Api列表

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

1. 接口描述

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

查询网关所有分组下Api列表

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

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

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeGatewayAllGroupApis
Version 是 否 String 公共参数，本接口取值：2018-03-26
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
GatewayDeployGroupId 是 否 String 网关部署组ID
示例值：
SearchWord 否 否 String 搜索关键字，支持命名空间名称或服务名称
示例值：

3. 输出参数

参数名称 类型 描述
Result GatewayVo 网关分组和API列表信息
示例值：查看
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
InvalidParameterValue.GatewayParameterInvalid 无效请求参数:%s。
MissingParameter.GatewayParameterRequired 缺少请求参数:%s。
FailedOperation.GatewayRemoteCallError 远端访问错误: %s。
InvalidParameterValue.DeployGroupNotExists 部署组不存在。

5. 示例

示例1 查询网关下分组和API

输入示例

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

{
  "GatewayDeployGroupId": "group-yd3b588a",
  "SearchWord": "default"
}

输出示例

{
  "Response": {
    "RequestId": "8d5aacf5-0ad5-40ed-85ca-d7ef71c85c57",
    "Result": {
      "GatewayDeployGroupId": "group-yd3b588a",
      "GatewayDeployGroupName": "group-zuul-1",
      "GroupNum": 1,
      "Groups": [
        {
          "GatewayInstanceId": "gw-ins-b09khqjq",
          "GatewayInstanceType": "none",
          "GroupApiCount": 2,
          "GroupApis": [
            {
              "ApiId": "api-0i1r0zuh",
              "Method": "GET",
              "MicroserviceName": "provider-demo",
              "NamespaceName": "ns_default",
              "Path": "/checkToken"
            },
            {
              "ApiId": "api-m0csucjn",
              "Method": "GET",
              "MicroserviceName": "provider-demo",
              "NamespaceName": "ns_default",
              "Path": "/swagger/getMessageDetail"
            }
          ],
          "GroupId": "grp-nb08ur29",
          "GroupName": "grp_app"
        }
      ]
    }
  }
}