查询NAT网关

最近更新时间:2020-08-05 08:21:01

1. 接口描述

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

本接口(DescribeNatGateways)用于查询 NAT 网关。

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

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeNatGateways。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
NatGatewayIds.N Array of String NAT网关统一 ID,形如:nat-123xx454
Filters.N Array of Filter 过滤条件,参数不支持同时指定NatGatewayIds和Filters。
  • nat-gateway-id - String - (过滤条件)协议端口模板实例ID,形如:nat-123xx454
  • vpc-id - String - (过滤条件)私有网络 唯一ID,形如:vpc-123xx454
  • nat-gateway-name - String - (过滤条件)协议端口模板实例ID,形如:test_nat
  • tag-key - String - (过滤条件)标签键,形如:test-key
  • Offset Integer 偏移量,默认为0。
    Limit Integer 返回数量,默认为20,最大值为100。

    3. 输出参数

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

    4. 示例

    示例1 查询 NAT 网关信息-2

    用NatGatewayIds进行查询NAT网关信息。

    输入示例

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

    输出示例

    {
      "Response": {
        "NatGatewaySet": [
          {
            "NatGatewayId": "nat-3isn9hr0",
            "NatGatewayName": "test",
            "VpcId": "vpc-0yi4hekt",
            "CreatedTime": "2017-09-20 20:28:24",
            "State": "AVAILABLE",
            "NetworkState": "RUNNING",
            "InternetMaxBandwidthOut": 100,
            "MaxConcurrentConnection": 1000000,
            "PublicIpAddressSet": [
              {
                "AddressId": "eip-7qcdm91q",
                "PublicIpAddress": "139.199.232.238",
                "IsBlocked": false
              }
            ],
            "DestinationIpPortTranslationNatRuleSet": [
              {
                "IpProtocol": "TCP",
                "PublicIpAddress": "139.199.232.238",
                "PublicPort": 8586,
                "PrivateIpAddress": "10.80.80.41",
                "PrivatePort": 8989,
                "Description": "test_modify"
              },
              {
                "IpProtocol": "UDP",
                "PublicIpAddress": "139.199.232.238",
                "PublicPort": 8989,
                "PrivateIpAddress": "10.80.80.41",
                "PrivatePort": 8989,
                "Description": "test_dnapt"
              }
            ],
            "Zone": "ap-guangzhou-1",
            "TagSet": [
              {
                "Key": "test-key",
                "Value": "test-value1"
              }
            ]
          },
          {
            "NatGatewayId": "nat-mxkohguo",
            "NatGatewayName": "aaaaaa",
            "VpcId": "vpc-m7sihqw5",
            "CreatedTime": "2018-07-25 11:37:29",
            "State": "PENDING",
            "NetworkState": "UNAVAILABLE",
            "InternetMaxBandwidthOut": 100,
            "MaxConcurrentConnection": 1000000,
            "PublicIpAddressSet": [],
            "DestinationIpPortTranslationNatRuleSet": [],
            "Zone": "ap-guangzhou-1",
            "TagSet": [
              {
                "Key": "test-key",
                "Value": "test-value2"
              }
            ]
          }
        ],
        "TotalCount": 2,
        "RequestId": "fed7e087-083f-49e4-8754-17fb130828e0"
      }
    }

    示例2 查询 NAT 网关信息

    用Filters进行查询NAT网关信息。

    输入示例

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

    输出示例

    {
      "Response": {
        "NatGatewaySet": [
          {
            "NatGatewayId": "nat-3isn9hr0",
            "NatGatewayName": "test",
            "VpcId": "vpc-0yi4hekt",
            "CreatedTime": "2017-09-20 20:28:24",
            "State": "AVAILABLE",
            "NetworkState": "RUNNING",
            "InternetMaxBandwidthOut": 100,
            "MaxConcurrentConnection": 1000000,
            "PublicIpAddressSet": [
              {
                "AddressId": "eip-7qcdm91q",
                "PublicIpAddress": "139.199.232.238",
                "IsBlocked": false
              }
            ],
            "DestinationIpPortTranslationNatRuleSet": [
              {
                "IpProtocol": "TCP",
                "PublicIpAddress": "139.199.232.238",
                "PublicPort": 8586,
                "PrivateIpAddress": "10.80.80.41",
                "PrivatePort": 8989,
                "Description": "test_modify"
              },
              {
                "IpProtocol": "UDP",
                "PublicIpAddress": "139.199.232.238",
                "PublicPort": 8989,
                "PrivateIpAddress": "10.80.80.41",
                "PrivatePort": 8989,
                "Description": "test_dnapt"
              }
            ],
            "Zone": "ap-guangzhou-1",
            "TagSet": [
              {
                "Key": "test-key",
                "Value": "test-value3"
              }
            ]
          },
          {
            "NatGatewayId": "nat-7xh58vea",
            "NatGatewayName": "test_create",
            "VpcId": "vpc-0yi4hekt",
            "CreatedTime": "2019-05-04 15:01:11",
            "State": "PENDING",
            "NetworkState": "RUNNING",
            "InternetMaxBandwidthOut": 100,
            "MaxConcurrentConnection": 1000000,
            "PublicIpAddressSet": [],
            "DestinationIpPortTranslationNatRuleSet": [],
            "Zone": "ap-guangzhou-2",
            "TagSet": [
              {
                "Key": "test-key",
                "Value": "test-value4"
              }
            ]
          }
        ],
        "TotalCount": 2,
        "RequestId": "a3964872-e2f5-4180-8607-0b49ec8e0109"
      }
    }

    5. 开发者资源

    API Explorer

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidParameterValue.Malformed 入参格式不合法。
    目录