调用DescribeNatGateways接口查询已创建的NAT网关。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeNatGateways

要执行的操作，取值：DescribeNatGateways。

RegionId String 是 cn-hangzhou

NAT网关所在的地域，您可以通过调用DescribeRegions接口获取地域ID。

NatGatewayId String 否 ngw-bp1uewa15k4iy5770****

NAT网关的ID。
VpcId String 否 vpc-bp15zckdt37pq72z****

VPC的ID。
Name String 否 test

NAT网关的名称。
InstanceChargeType String 否 PostPaid

实例的付费方式，取值：

  • PostPaid：按量计费。
  • PrePaid：预付费。

国际站仅支持PostPaid（按量计费）。
Spec String 否 Large

NAT网关的规格，取值：

  • Small(默认值)：小型。
  • Middle：中型。
  • Large：大型。
  • XLarge.1：超大型。
NatType String 否 Normal

NAT网关的类型，取值：Normal（普通型）。
ResourceGroupId String 否 rg-bp67acfmxazb4ph****

资源组ID。
PageNumber Integer 否 10

列表的页码，默认值为1。
PageSize Integer 否 1

分页查询时每页的行数，最大值为100，默认值为10。

返回数据

名称 类型 示例值 描述
RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

用户请求ID。
TotalCount Integer 10

列表条目数。
PageNumber Integer 10

当前页码。
PageSize Integer 10

每页包含的条目数。
NatGateways Array

NAT网关的详细信息。
NatGatewayId String ngw-bp1047e2d4z7kf2ki****

NAT网关的ID。
RegionId String cn-hangzhou

NAT网关的所在地域ID。
Name String abc

NAT网关实例名称。
Description String NAT

NAT网关的描述。
VpcId String vpc-bp15zckdt37pq72z****

VPC的ID。
Spec String Small

NAT网关的规格。
InstanceChargeType String PostPaid

实例的付费方式。

  • PostPaid：按量计费。
  • PrePaid：预付费。

国际站仅支持PostPaid（按量计费）。
ExpiredTime String 2017-08-26T16:00Z

NAT网关的过期时间。
AutoPay Boolean true

是否自动付费，取值：

  • false：不开启自动付费，生成订单后需要到订单中心完成支付。
  • true：开启自动付费，自动支付订单。
说明 InstanceChargeType参数的值为PrePaid时，该参数必选。
BusinessStatus String Normal

NAT网关的业务状态：

  • Normal：正常。
  • FinancialLocked：欠费锁定状态。
  • SecurityLocked：安全风控锁定状态。
CreationTime String 2017-06-08T12:20:55

创建时间。按照ISO8601标准表示，并需要使用UTC时间。格式为：YYYY-MM-DDThh:mmZ。
Status String Initiating

NAT网关的状态。

  • Initiating：初始化中。
  • Available：可用。
  • Pending：配置中。
NatType String Normal

NAT网关的类型，仅返回Normal（普通型）。
InternetChargeType String PayBySpec

NAT网关的计费类型。仅返回PayBySpec（按规格计费）。
ResourceGroupId String rg-bp67acfmxazb4ph****

资源组ID。
DeletionProtection Boolean true

是否开启了删除保护功能。

  • true：已开启。
  • false：未开启。
IpLists Array

NAT网关绑定的弹性公网IP。
IpAddress String 116.62.222.xx

弹性公网IP的地址。
ForwardTableIds List ftb-uf6gj3mhsg94qsqst****

端口转发表ID。
SnatTableIds List stb-uf6dalcdu0krz423p****

NAT网关的SNAT表ID。
BandwidthPackageIds List bwp-s6lmotmkk****

NAT网关绑定的带宽包ID。
NatGatewayPrivateInfo Struct

NAT网关的私有信息。

NatType取值为Normal时，该列表中返回的参数均为空值。
EniInstanceId Integer 10

弹性网卡实例ID。
PrivateIpAddress String 192.168.1.xx

私网IP地址。
VswitchId String vsw-bp1s2laxhdf9ayjbo****

交换机ID。
IzNo String cn-hangzhou-b

可用区。
MaxBandwidth Integer 5120

最大带宽值，单位为Mbps。

示例

请求示例

http(s)://vpc.aliyuncs.com/?Action=DescribeNatGateways
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式 

<DescribeNatGatewaysResponse>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>1207C80C-7CAB-4874-A9A0-D19EC9F35490</RequestId>
    <NatGateways>
            <NatGateway>
                    <Description></Description>
                    <Spec>Small</Spec>
                    <IpLists>
                            <IpList>
                                    <IpAddress>118.xx.xx.181</IpAddress>
                                    <AllocationId>eip-bp1xyg5ipmh3nledx****</AllocationId>
                                    <UsingStatus>UsedBySnatTable</UsingStatus>
                            </IpList>
                            <IpList>
                                    <IpAddress>47.xx.xx.34</IpAddress>
                                    <AllocationId>eip-bp19eue77u20cffjc****</AllocationId>
                                    <UsingStatus>UsedByForwardTable</UsingStatus>
                            </IpList>
                    </IpLists>
                    <ForwardTableIds>
                            <ForwardTableId>ftb-bp15o9aylj19vfvgt****</ForwardTableId>
                    </ForwardTableIds>
                    <VpcId>vpc-bp15k6sx6fhdz2jw4****</VpcId>
                    <NatGatewayId>ngw-bp1047e2d4z7kf2ki****</NatGatewayId>
                    <CreationTime>2018-01-10T09:48:29Z</CreationTime>
                    <BandwidthPackageIds>
        </BandwidthPackageIds>
                    <Name></Name>
                    <Status>Available</Status>
                    <BusinessStatus>Normal</BusinessStatus>
                    <RegionId>cn-hangzhou</RegionId>
                    <SnatTableIds>
                            <SnatTableId>stb-bp1tyr0o48w6wymur****</SnatTableId>
                    </SnatTableIds>
                    <InstanceChargeType>PostPaid</InstanceChargeType>
            </NatGateway>
    </NatGateways>
</DescribeNatGatewaysResponse>

JSON 格式 

{
    "PageNumber": 1, 
    "TotalCount": 1, 
    "PageSize": 10, 
    "RequestId": "1207C80C-7CAB-4874-A9A0-D19EC9F35490", 
    "NatGateways": {
        "NatGateway": [ 
            {
                "Description": "", 
                "Spec": "Small", 
                "IpLists": {
                    "IpList": [
                        {
                            "IpAddress": "118.xx.xx.181", 
                            "AllocationId": "eip-bp1xyg5ipmh3nledx****", 
                            "UsingStatus": "UsedBySnatTable"
                        }, 
                        {
                            "IpAddress": "47.xx.xx.34", 
                            "AllocationId": "eip-bp19eue77u20cffjc****", 
                            "UsingStatus": "UsedByForwardTable"
                        }
                    ]
                }, 
                "ForwardTableIds": {
                    "ForwardTableId": [
                        "ftb-bp15o9aylj19vfvgt****"
                    ]
                }, 
                "VpcId": "vpc-bp15k6sx6fhdz2jw4****", 
                "NatGatewayId": "ngw-bp1047e2d4z7kf2ki****", 
                "CreationTime": "2018-01-10T09:48:29Z", 
                "BandwidthPackageIds": {
                    "BandwidthPackageId": [ ]
                }, 
                "Name": "", 
                "Status": "Available", 
                "BusinessStatus": "Normal", 
                "RegionId": "cn-hangzhou", 
                "SnatTableIds": {
                    "SnatTableId": [
                        "stb-bp1tyr0o48w6wymur****"
                    ]
                }, 
                "InstanceChargeType": "PostPaid"
            }
        ]
    }
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidRegionId.NotFound The specified RegionId does not exist in our records. 指定的 RegionId 不存在，请您检查此产品在该地域是否可用。

访问错误中心查看更多错误码。