1. 接口描述

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

本接口（DescribeNatGateways）用于查询 NAT 网关。

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

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

2. 输入参数

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

3. 输出参数

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 平台

腾讯云 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
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for NodeJS
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++
• Tencent Cloud SDK 3.0 for Ruby

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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