1. 接口描述
接口请求域名: tse.tencentcloudapi.com 。
获取云原生API网关实例列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeCloudNativeAPIGateways。 |
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 。 |
Limit | 否 | Integer | 返回数量,默认为 20,最大值为 100。 示例值:20 |
Offset | 否 | Integer | 偏移量,默认为 0。 示例值:0 |
Filters.N | 否 | Array of Filter | 请求过滤参数,支持按照实例名称、ID和标签键值(Name、GatewayId、Tag)筛选 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Result | ListCloudNativeAPIGatewayResult | 获取云原生API网关实例列表响应结果。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 测试获取云原生API网关实例列表
输入示例
https://tse.tencentcloudapi.com/?Action=DescribeCloudNativeAPIGateways
&Limit=20
&Offset=0
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "67e07f5b-d31a-47b3-8a67-bf10e48fc1a6",
"Result": {
"TotalCount": 1,
"GatewayList": [
{
"GatewayId": "gateway-dde03767",
"Name": "公网入口网关",
"IngressClassName": "tse-nginx-ingress",
"Type": "kong",
"GatewayVersion": "2.5.1",
"GatewayMinorVersion": "",
"NodeConfig": {
"Specification": "1c2g",
"Number": 2
},
"VpcConfig": {
"VpcId": "vpc-83p0o405",
"SubnetId": "subnet-8tzp8ugg"
},
"Description": "",
"Status": "Running",
"EnableCls": false,
"CreateTime": "2024-10-08 20:27:38",
"Tags": [],
"TradeType": 0,
"FeatureVersion": "PROFESSIONAL",
"InternetMaxBandwidthOut": 1,
"AutoRenewFlag": 0,
"CurDeadline": "2024-10-08 20:27:38",
"IsolateTime": "2024-10-08 20:27:38",
"EnableInternet": true,
"EngineRegion": "ap-guangzhou",
"InternetPayMode": "TRAFFIC",
"LoadBalancerType": "",
"PublicIpAddresses": [
"193.112.82.224"
]
}
]
}
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure.UnauthorizedOperation | 未授权操作错误。 |
FailedOperation | 操作失败。 |
FailedOperation.FailedOperation | 操作失败。 |
FailedOperation.InternalError | 操作失败,内部错误。 |
FailedOperation.Role | 获取临时密钥失败 |
InternalError.HttpStatusCodeError | 状态码错误。 |
InternalError.IOError | 内部服务调用异常。 |
InternalError.QueryError | 查询内部错误。 |
InternalError.UnknownError | 未知错误。 |
InvalidParameterValue.BadRequestFormat | 请求格式不正确。 |
InvalidParameterValue.GatewayId | 网关ID无效 |
InvalidParameterValue.InvalidParameterValue | 无效的参数值。 |
InvalidParameterValue.QueryError | 无效请求参数,查询失败。 |
InvalidParameterValue.Region | 无效的Region。 |
LimitExceeded.LimitExceeded | 参数超过限制。 |
MissingParameter.MissParameter | 缺少参数。 |
OperationDenied.OperationDenied | 不允许的操作。 |
ResourceNotFound.InstanceNotFound | 实例不存在。 |
ResourceNotFound.ResourceNotFound | 资源不存在。 |
UnauthorizedOperation.UnauthorizedOperation | 未授权的操作。 |
UnsupportedOperation | 操作不支持。 |