1. 接口描述
接口请求域名: tsf.tencentcloudapi.com 。
查询某个网关绑定的API 分组信息列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeGroupGateways。 |
Version | 是 | String | 公共参数,本接口取值:2018-03-26。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
GatewayDeployGroupId | 是 | String | 网关部署组ID 示例值:group-yd3b588a |
Offset | 是 | Integer | 翻页查询偏移量 示例值:0 |
Limit | 是 | Integer | 翻页查询每页记录数 示例值:5 |
SearchWord | 否 | String | 搜索关键字 示例值:grpName |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Result | TsfPageApiGroupInfo | API分组信息 示例值:{"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":"本地配置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":"/grpCxt","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} |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询某个网关绑定的API 分组信息列表
输入示例
POST / HTTP/1.1
Host: tsf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGroupGateways
<公共请求参数>
{
"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": [],
"CreatedTime": null,
"Description": null,
"GatewayInstanceId": null,
"GatewayInstanceIdList": null,
"GatewayInstanceType": null,
"GroupContext": null,
"GroupId": "non-tsf-gateway-group",
"GroupName": "本地配置API",
"GroupType": null,
"NamespaceNameKey": null,
"NamespaceNameKeyPosition": "path",
"ServiceNameKey": null,
"ServiceNameKeyPosition": "path",
"Status": null,
"UpdatedTime": null
},
{
"AclMode": "none",
"ApiCount": 15,
"AuthType": "none",
"BindedGatewayDeployGroups": [],
"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
}
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.GatewayRemoteCallError | 远端访问错误: %s。 |
FailedOperation.TsfPrivilegeError | TSF权限模块异常,请联系系统管理员。。 |
InternalError.GatewayDbError | 网关数据异常。 |
ResourceNotFound.MicroserviceOffline | 目标微服务已离线[%s]。。 |