租户端 互联网中间件 微服务框架(TSF) 微服务网关相关接口 查询某个API分组已绑定的网关部署组信息列表

查询某个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 公共参数,本接口取值:DescribeGroupBindedGateways
Version 是 否 String 公共参数,本接口取值:2018-03-26
Region 是 否 String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
GroupId 是 否 String API 分组ID
示例值:
Offset 是 否 Int64 翻页查询偏移量
示例值:
Limit 是 否 Int64 翻页查询每页记录数
示例值:
SearchWord 否 否 String 搜索关键字
示例值:

3. 输出参数

参数名称 类型 描述
Result TsfPageGatewayDeployGroup 翻页结构体
示例值:查看
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

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

5. 示例

示例1 查询某个API分组已绑定的网关部署组信息列表

输入示例

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

{
  "GroupId": "grp-nb08ur29",
  "SearchWord": "zuul",
  "Offset": 0,
  "Limit": 5
}

输出示例

{
  "Response": {
    "RequestId": "f5e456a5-94c9-46d3-96ab-27dd24948da5",
    "Result": {
      "Content": [
        {
          "ApplicationId": "application-ydopqnxa",
          "ApplicationName": "shedfree-gw",
          "ApplicationType": "V",
          "ClusterType": "V",
          "DeployGroupId": "group-yd3b588a",
          "DeployGroupName": "shed-zuul-1",
          "GroupStatus": "Running"
        },
        {
          "ApplicationId": "application-ydopqnxa",
          "ApplicationName": "shedfree-gw",
          "ApplicationType": "V",
          "ClusterType": "V",
          "DeployGroupId": "group-yq9d6wev",
          "DeployGroupName": "shed-zuul-3",
          "GroupStatus": "Running"
        },
        {
          "ApplicationId": "application-ydopqnxa",
          "ApplicationName": "shedfree-gw",
          "ApplicationType": "V",
          "ClusterType": "V",
          "DeployGroupId": "group-yx87px4a",
          "DeployGroupName": "shed-zuul-2",
          "GroupStatus": "Running"
        }
      ],
      "TotalCount": 3
    }
  }
}