1. 接口描述
接口请求域名： tse.tencentcloudapi.com 。
查询云原生网关分组信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeNativeGatewayServerGroups。 |
| Version | 是 | String | 公共参数，本接口取值：2020-12-07。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-chengdu, ap-guangzhou, ap-hongkong, ap-mumbai, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley 。 |
| GatewayId | 是 | String | 云原生API网关实例ID。 示例值：gateway-test1234 |
| Offset | 否 | Integer | 偏移量，默认为 0。 示例值：0 |
| Limit | 否 | Integer | 返回数量，默认为 20。 示例值：20 |
| Filters.N | 否 | Array of Filter | 过滤参数，支持按照分组名称、分组ID（Name、GroupId）筛选 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | NativeGatewayServerGroups | 分组列表信息 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询云原生网关分组信息
查询云原生网关分组信息
输入示例
POST / HTTP/1.1
Host: tse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeNativeGatewayServerGroups
<公共请求参数>
{
"GatewayId": "gateway-dde03767",
"Offset": 0,
"Limit": 1,
"Filters": [
{
"Name": "GroupId",
"Values": [
"group-4se0czf7"
]
}
]
}输出示例
{
"Response": {
"RequestId": "7c6a2512-8040-4ce7-b8ba-30f1bf585867",
"Result": {
"GatewayGroupList": [
{
"GatewayId": "gateway-dde03767",
"GroupId": "group-4se0czf7",
"Name": "默认分组",
"Description": "",
"NodeConfig": {
"Specification": "16c32g",
"Number": 10
},
"SubnetIds": "subnet-ec94pncc",
"InternetMaxBandwidthOut": 15,
"Status": "Running",
"CreateTime": "2024-03-29 11:02:32",
"ModifyTime": "2024-11-08 11:30:36",
"IsFirstGroup": 1,
"BindingStrategy": {
"StrategyId": "strategy-0c509e2d",
"StrategyName": "弹性伸缩",
"Description": "",
"GatewayId": "",
"Config": {
"MaxReplicas": 0,
"Metrics": null
},
"CreateTime": "",
"ModifyTime": "",
"CronConfig": {
"StrategyId": "",
"Enabled": false,
"Params": null,
"CreateTime": "",
"ModifyTime": ""
},
"MaxReplicas": 0
},
"DefaultWeight": 20
}
],
"TotalCount": 1
}
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.InternalError | 服务内部错误。 |
| InvalidParameterValue.InvalidParameterValue | 无效的参数值。 |
| ResourceNotFound.ResourceNotFound | 资源不存在。 |
