1. 接口描述
接口请求域名: vpc.tencentcloudapi.com 。
本接口(DescribePrivateNatGateways)用于查询私网NAT网关
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribePrivateNatGateways。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
NatGatewayIds.N | 否 | Array of String | 私网网关唯一ID ,形如:intranat-0g3blj80 。示例值:["intranat-0g3blj80"] |
Filters.N | 否 | Array of Filter | 过滤条件。ID ,形如:intranat-0g3blj80 。VpcId 。 |
Offset | 否 | Integer | 偏移量,默认为0。 示例值:0 |
Limit | 否 | Integer | 返回数量,默认为20。 示例值:20 |
OrderField | 否 | String | 排序字段。可选值:"NatGatewayId"、"NatGatewayName"、"CreatedTime" 示例值:"NatGatewayId" |
OrderDirection | 否 | String | 排序方式。可选值:"ASC"、"DESC"。 示例值:"ASC" |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 符合条件的对象数。 示例值:1 |
PrivateNatGatewaySet | Array of PrivateNatGateway | 私网网关对象数组。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 按ID过滤查询私网NAT网关
按ID过滤查询私网NAT网关
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePrivateNatGateways
<公共请求参数>
{
"NatGatewayIds": [
"intranat-0g3blj80"
]
}
输出示例
{
"Response": {
"PrivateNatGatewaySet": [
{
"NatGatewayId": "intranat-0g3blj80",
"NatGatewayName": "test_nat",
"VpcId": "vpc-noanwmed",
"Status": "AVAILABLE",
"CrossDomain": false,
"CreatedTime": "2022-09-29 15:58:00",
"DirectConnectGatewayIds": [],
"TagSet": []
}
],
"TotalCount": 1,
"RequestId": "757e8409-faa3-4b7f-bfc3-7e1670bf40af"
}
}
示例2 按标签过滤查询私网NAT网关
按标签过滤查询私网NAT网关
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePrivateNatGateways
<公共请求参数>
{
"Filters": [
{
"Name": "TagKey",
"Values": [
"负责人"
]
}
]
}
输出示例
{
"Response": {
"TotalCount": 1,
"PrivateNatGatewaySet": [
{
"NatGatewayId": "intranat-ryur99m8",
"NatGatewayName": "example",
"VpcId": "vpc-d3rrkwej",
"Status": "AVAILABLE",
"CrossDomain": false,
"CreatedTime": "2023-03-09 16:19:24",
"TagSet": [
{
"Key": "负责人",
"Value": "abc"
}
],
"DirectConnectGatewayIds": [],
"NatType": "DCG",
"CrossDomainInfo": {
"CcnId": "ccn-123abcef",
"LocalVpcId": "vpc-12345678",
"PeerVpcId": "vpc-abcdefgh"
}
}
],
"RequestId": "e13d67ca-4b7b-4337-b8c5-7df7707c89ca"
}
}
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 | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.Coexist | 参数不支持同时指定。 |
InvalidParameter.FilterInvalidKey | 指定过滤条件不存在。 |
InvalidParameter.FilterNotDict | 指定过滤条件不是键值对。 |
InvalidParameter.FilterValuesNotList | 指定过滤选项值不是列表。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.Malformed | 入参格式不合法。 |
InvalidParameterValue.TooLong | 无效参数值。参数值太长。 |
MissingParameter | 缺少参数错误。 |
UnknownParameter | 未知参数错误。 |
UnknownParameter.WithGuess | 参数无法识别,可以尝试相似参数代替。 |
UnsupportedOperation | 操作不支持。 |
UnsupportedOperation.ActionNotFound | 接口不存在。 |