文档中心 API 中心 私有网络 NAT网关相关接口 查询NAT网关端口转发规则

查询NAT网关端口转发规则

最近更新时间:2019-08-01 17:27:01

1. 接口描述

接口请求域名: vpc.tencentcloudapi.com 。

本接口(DescribeNatGatewayDestinationIpPortTranslationNatRules)用于查询NAT网关端口转发规则对象数组。

默认接口请求频率限制:100次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:vpc.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeNatGatewayDestinationIpPortTranslationNatRules
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的 地域列表
NatGatewayIds.N Array of String NAT网关ID。
Filters.N Array of Filter 过滤条件:
参数不支持同时指定NatGatewayIds和Filters。
  • nat-gateway-id,NAT网关的ID,如nat-0yi4hekt
  • vpc-id,私有网络VPC的ID,如vpc-0yi4hekt
  • public-ip-address, 弹性IP,如139.199.232.238
  • public-port, 公网端口。
  • private-ip-address, 内网IP,如10.0.0.1
  • private-port, 内网端口。
  • description,规则描述。
  • Offset Integer 偏移量,默认为0。
    Limit Integer 返回数量,默认为20,最大值为100。

    3. 输出参数

    参数名称 类型 描述
    NatGatewayDestinationIpPortTranslationNatRuleSet Array of NatGatewayDestinationIpPortTranslationNatRule NAT网关端口转发规则对象数组。
    TotalCount Integer 符合条件的NAT网关端口转发规则对象数目。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询NAT网关端口转发规则

    用NatGatewayId数组拉取NAT网关的端口转发规则

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeNatGatewayDestinationIpPortTranslationNatRules
    &NatGatewayIds.0=nat-3isn9hr0
    &Offset=0
    &Limit=10
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "TotalCount": 2,
        "NatGatewayDestinationIpPortTranslationNatRuleSet": [
          {
            "IpProtocol": "TCP",
            "PublicIpAddress": "139.199.232.238",
            "PublicPort": 8989,
            "PrivateIpAddress": "10.80.80.41",
            "PrivatePort": 8989,
            "Description": "test_dnapt",
            "CreatedTime": "2019-05-04 13:09:25",
            "NatGatewayId": "nat-3isn9hr0",
            "VpcId": "vpc-0yi4hekt"
          },
          {
            "IpProtocol": "UDP",
            "PublicIpAddress": "139.199.232.238",
            "PublicPort": 8989,
            "PrivateIpAddress": "10.80.80.41",
            "PrivatePort": 8989,
            "Description": "test_dnapt",
            "CreatedTime": "2019-05-04 13:20:20",
            "NatGatewayId": "nat-3isn9hr0",
            "VpcId": "vpc-0yi4hekt"
          }
        ],
        "RequestId": "9b751ec3-d10a-4138-bdd9-fa5564684e60"
      }
    }

    示例2 查询NAT网关端口转发规则

    用Filter数组拉取NAT网关的端口转发规则

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeNatGatewayDestinationIpPortTranslationNatRules
    &Filters.0.Name=vpc-id
    &Filters.0.Values.0=vpc-0yi4hekt
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "TotalCount": 2,
        "NatGatewayDestinationIpPortTranslationNatRuleSet": [
          {
            "IpProtocol": "TCP",
            "PublicIpAddress": "139.199.232.238",
            "PublicPort": 8989,
            "PrivateIpAddress": "10.80.80.41",
            "PrivatePort": 8989,
            "Description": "test_dnapt",
            "CreatedTime": "2019-05-04 13:42:11",
            "NatGatewayId": "nat-3isn9hr0",
            "VpcId": "vpc-0yi4hekt"
          },
          {
            "IpProtocol": "UDP",
            "PublicIpAddress": "139.199.232.238",
            "PublicPort": 8989,
            "PrivateIpAddress": "10.80.80.41",
            "PrivatePort": 8989,
            "Description": "test_dnapt",
            "CreatedTime": "2019-05-04 13:20:20",
            "NatGatewayId": "nat-3isn9hr0",
            "VpcId": "vpc-0yi4hekt"
          }
        ],
        "RequestId": "eb203971-a7a0-45c1-9c72-36ad86688590"
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    InternalServerError 操作内部错误。
    InvalidAddressId.NotFound 指定的EIP不存在。
    InvalidParameter 入参不合法。
    InvalidParameter.Coexist 参数不支持同时指定。
    InvalidParameterValue 参数值不合法。
    InvalidParameterValue.Duplicate 入参重复。
    InvalidParameterValue.LimitExceeded 参数值超出限制。
    InvalidParameterValue.Malformed 入参格式不合法。
    UnauthorizedOperation 未授权操作。