1. 接口描述
接口请求域名: cngw.tencentcloudapi.com 。
查询云原生网关服务和路由列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeCNGWServicesWithRoutes。 |
| Version | 是 | String | 公共参数,本接口取值:2023-04-18。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| GatewayId | 是 | String | 网关ID 示例值:gateway-2c8a4896 |
| Limit | 否 | Integer | 列表数量 示例值:10 |
| Offset | 否 | Integer | 列表 offset 示例值:0 |
| Filters.N | 否 | Array of ListFilter | 过滤条件,多个过滤条件之间是与的关系,支持 name,upstreamType |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | KongServiceWithRoutes | 服务及路由查询结果 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询云原生网关服务和路由列表
输入示例
POST / HTTP/1.1
Host: cngw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCNGWServicesWithRoutes
<公共请求参数>
{
"GatewayId": "gateway-2c8a4896",
"Limit": 10,
"Offset": 0
}
输出示例
{
"Response": {
"Result": {
"ServiceList": [
{
"RouteHasMore": false,
"RouteTotalCount": 1,
"Routes": [
{
"CreatedTime": "2026-07-25 16:26:52",
"DestinationPorts": [],
"ForceHttps": false,
"Headers": [],
"Hosts": null,
"HttpsRedirectStatusCode": 426,
"ID": "0a6919f3-0d86-4413-9cac-1bc6af54ace3",
"Methods": [
"ANY"
],
"Name": "mirror",
"Paths": [
"/mirror"
],
"PreserveHost": false,
"Protocols": [
"http"
],
"RegexPriority": 0,
"RequestBuffering": true,
"ResponseBuffering": true,
"ServiceID": "092cf1ac-a840-4359-bc6b-448318ee6361",
"ServiceName": "mirror",
"StripPath": true
}
],
"Service": {
"CreatedTime": "2026-07-25 16:24:33",
"Editable": true,
"ID": "092cf1ac-a840-4359-bc6b-448318ee6361",
"Name": "mirror",
"Path": "/",
"Tags": [
"TSE-Service-Type:Kubernetes"
],
"UpstreamInfo": {
"Algorithm": "round-robin",
"HealthStatus": "HEALTHCHECKS_OFF",
"Namespace": "traffic-mirror-test",
"Port": 8889,
"RealSourceType": "EKS",
"ServiceName": "mirror-target",
"SourceID": "cls-koqdd0fq",
"SourceName": "【勿删除】tre-压测",
"SourceType": "EKS",
"Targets": [
{
"CreatedTime": "2026-07-27 18:53:10",
"Health": "HEALTHCHECKS_OFF",
"Host": "10.0.20.81",
"Port": 8889,
"Source": "",
"Weight": 100
}
]
},
"UpstreamType": "Kubernetes"
}
}
],
"TotalCount": 2
},
"RequestId": "fb110fc8-a91c-4db6-89cd-5a7327245292"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.FailedOperation | FailedOperation.FailedOperation |
| FailedOperation.InternalError | FailedOperation.InternalError |
| FailedOperation.Role | FailedOperation.Role |
| FailedOperation.Vpc | FailedOperation.Vpc |
| InternalError | 内部错误。 |
| InternalError.IOError | InternalError.IOError |
| InternalError.QueryError | InternalError.QueryError |
| InternalError.UnknownError | InternalError.UnknownError |
| InvalidParameterValue.BadRequestFormat | InvalidParameterValue.BadRequestFormat |
| InvalidParameterValue.InvalidParameterValue | InvalidParameterValue.InvalidParameterValue |
| InvalidParameterValue.OperationFailed | InvalidParameterValue.OperationFailed |
| InvalidParameterValue.Region | InvalidParameterValue.Region |
| InvalidParameterValue.ResourceAlreadyExist | InvalidParameterValue.ResourceAlreadyExist |
| InvalidParameterValue.Specification | InvalidParameterValue.Specification |
| InvalidParameterValue.Type | InvalidParameterValue.Type |
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound.InstanceNotFound | ResourceNotFound.InstanceNotFound |
| ResourceNotFound.ResourceNotFound | ResourceNotFound.ResourceNotFound |
| UnauthorizedOperation.CamNoAuth | UnauthorizedOperation.CamNoAuth |
| UnauthorizedOperation.CamPassRoleNotExist | UnauthorizedOperation.CamPassRoleNotExist |
| UnauthorizedOperation.Uin | UnauthorizedOperation.Uin |
| UnauthorizedOperation.UnauthorizedOperation | UnauthorizedOperation.UnauthorizedOperation |