查询某个网关绑定的API 分组信息列表

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

1. 接口描述

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

查询某个网关绑定的API 分组信息列表

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

接口更新时间：2026-03-13 14:39:39。

接口只验签名不鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeGroupGateways
Version	是	否	String	公共参数，本接口取值：2018-03-26
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Offset	是	否	Int64	翻页查询偏移量示例值： 0
Limit	是	否	Int64	翻页查询每页记录数示例值： 100
SearchWord	否	否	String	搜索关键字示例值： grpName
GatewayDeployGroupId	是	否	String	网关部署组ID 示例值： group-yd3b588a

3. 输出参数

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

4. 错误码

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

错误码	描述
FailedOperation.GatewayRemoteCallError	远端访问错误: %s。
FailedOperation.TsfPrivilegeError	TSF权限模块异常，请联系系统管理员。。
InternalError.GatewayDbError	网关数据异常。
ResourceNotFound.MicroserviceOffline	目标微服务已离线[%s]。。

5. 示例

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

输入示例

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

{
  "GatewayDeployGroupId": "group-yd3b588a",
  "SearchWord": "grpName",
  "Offset": 0,
  "Limit": 5
}

输出示例

{
  "Response": {
    "RequestId": "c52f74e0-ed84-40b2-a57c-6489bd4eb700",
    "Result": {
      "Content": [
        {
          "AclMode": null,
          "ApiCount": 0,
          "AuthType": null,
          "BindedGatewayDeployGroups": [],
          "ClusterId": null,
          "ClusterName": null,
          "ClusterType": null,
          "CreatedTime": null,
          "Description": null,
          "GatewayInstanceId": null,
          "GatewayInstanceIdList": null,
          "GatewayInstanceType": null,
          "GroupContext": null,
          "GroupId": "non-tsf-gateway-group",
          "GroupName": "Local Configuration API",
          "GroupType": null,
          "NamespaceNameKey": null,
          "NamespaceNameKeyPosition": "path",
          "ServiceNameKey": null,
          "ServiceNameKeyPosition": "path",
          "Status": null,
          "UpdatedTime": null
        },
        {
          "AclMode": "none",
          "ApiCount": 15,
          "AuthType": "none",
          "BindedGatewayDeployGroups": [],
          "ClusterId": null,
          "ClusterName": null,
          "ClusterType": null,
          "CreatedTime": "2024-12-23 01:29:13",
          "Description": "",
          "GatewayInstanceId": "gw-ins-b09khqjq",
          "GatewayInstanceIdList": null,
          "GatewayInstanceType": "none",
          "GroupContext": "/ctx",
          "GroupId": "grp-nb08ur29",
          "GroupName": "grpName",
          "GroupType": "ms",
          "NamespaceNameKey": null,
          "NamespaceNameKeyPosition": "path",
          "ServiceNameKey": null,
          "ServiceNameKeyPosition": "path",
          "Status": "released",
          "UpdatedTime": "2024-12-23 01:30:03"
        }
      ],
      "TotalCount": 2
    }
  }
}