1. 接口描述
接口请求域名: vpc.tencentcloudapi.com 。
本接口(DescribePrivateNatGatewayDestinationIpPortTranslationNatRules)用于查询私网NAT网关目的端口转换规则
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribePrivateNatGatewayDestinationIpPortTranslationNatRules。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
NatGatewayId | 是 | String | 私网网关唯一ID ,形如"intranat-xxxxxxxx)示例值:intranat-0g3blj80 |
Filters.N | 否 | Array of Filter | 过滤条件,Name可选值"OriginalIp", "TranslationIp", "OriginalPort","TranslationPort", "Protocol", "Description" |
Offset | 否 | Integer | 偏移量,默认值为0。 示例值:0 |
Limit | 否 | Integer | 返回数目,默认值为20。 示例值:20 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 总规则数目。 示例值:2 |
LocalDestinationIpPortTranslationNatRuleSet | Array of PrivateNatDestinationIpPortTranslationNatRule | 目的端口转换规则数组。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询私网NAT网关目的端口转换规则
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePrivateNatGatewayDestinationIpPortTranslationNatRules
<公共请求参数>
{
"NatGatewayId": "intranat-0g3blj80",
"Filters": [
{
"Name": "Description",
"Values": [
"desc"
]
}
]
}
输出示例
{
"Response": {
"TotalCount": 2,
"LocalDestinationIpPortTranslationNatRuleSet": [
{
"Protocol": "TCP",
"TranslationIp": "10.0.0.34",
"TranslationPort": 5666,
"OriginalIp": "10.0.0.88",
"OriginalPort": 8888,
"Description": "chdesc",
"CreateTime": "2022-09-30 14:23:10",
"UpdateTime": "2022-09-30 14:33:16"
},
{
"Protocol": "TCP",
"TranslationIp": "10.0.0.35",
"TranslationPort": 5666,
"OriginalIp": "10.0.0.26",
"OriginalPort": 8888,
"Description": "desc",
"CreateTime": "2022-09-30 14:24:38",
"UpdateTime": "2022-09-30 14:24:38"
}
],
"RequestId": "cd37ad3b-6b94-41f4-bd83-8a2b0d801aae"
}
}
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.ModuleError | 内部模块错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.FilterInvalidKey | 指定过滤条件不存在。 |
InvalidParameter.FilterNotDict | 指定过滤条件不是键值对。 |
InvalidParameter.FilterValuesNotList | 指定过滤选项值不是列表。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.LimitExceeded | 参数值超出限制。 |
InvalidParameterValue.Malformed | 入参格式不合法。 |
InvalidParameterValue.PrivateNatRuleNotExists | 私网NAT网关规则不存在。 |
InvalidParameterValue.Range | 参数值不在指定范围。 |
MissingParameter | 缺少参数错误。 |
UnknownParameter | 未知参数错误。 |
UnknownParameter.WithGuess | 参数无法识别,可以尝试相似参数代替。 |