调用DescribeNatGateways以列表形式查询指定地域指定条件NAT网关的详细信息。

使用说明

本接口查询的NAT网关包括公网NAT网关和VPC NAT网关,文中出现的“NAT网关”不做具体的区分。

调试

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

请求参数

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

要执行的操作。取值:DescribeNatGateways

RegionId String cn-hangzhou

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

NatGatewayId String ngw-bp1uewa15k4iy5770****

要查询的NAT网关的ID。

VpcId String vpc-bp15zckdt37pq72z****

要查询的NAT网关所属VPC的ID。

Name String test

要查询的NAT网关的名称。

InstanceChargeType String PostPaid

要查询的NAT网关实例的付费模式,取值:PostPaid(按量付费)。

Spec String Small

公网NAT网关的规格,取值:

  • Small(默认值):小型。
  • Middle:中型。
  • Large:大型。
NatType String Normal

公网NAT网关的类型,取值:

  • Normal:普通型。
  • Enhanced:增强型。
ResourceGroupId String rg-bp67acfmxazb4ph****

要查询的NAT网关所属的资源组ID。

PageNumber Integer 10

列表的页码,默认值为1

PageSize Integer 1

分页查询时每页的行数,最大值为50,默认值为10

DryRun Boolean true

是否只预检此次请求,取值:

  • true:发送检查请求,不会查询资源状况。检查项包括AccessKey是否有效、RAM用户的授权情况和是否填写了必需参数。如果检查不通过,则返回对应错误。如果检查通过,会返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回2xx HTTP状态码并直接查询资源状况。
Status String Available

要查询的NAT网关的状态,取值:

  • Creating:创建NAT网关是异步操作,在创建完成之前是Creating状态。
  • Available:NAT网关创建完成后的状态,是稳定状态。
  • Modifying:变配NAT网关是异步操作,在变配的过程中是Modifying状态。
  • Deleting:删除NAT网关是异步操作,在删除的过程中是Deleting状态。
  • Converting:普通型NAT网关转换到增强型NAT网关是异步操作,在转换过程中是Converting状态。
NetworkType String internet

要查询的NAT网关的类型,取值:

  • internet:公网NAT网关。
  • intranet:VPC NAT网关。
ZoneId String cn-hangzhou-b

NAT网关所在的可用区ID。

返回数据

名称 类型 示例值 描述
PageSize Integer 10

每页包含的条目数。

RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

请求ID。

PageNumber Integer 10

当前页码。

TotalCount Integer 10

查询的NAT网关列表条目数。

NatGateways Array of NatGateway

NAT网关的详细信息。

NatGateway
Status String Creating

NAT网关的状态,取值:

  • Creating:创建NAT网关是异步操作,在创建完成之前是Creating状态。
  • Available:NAT网关创建完成后的状态,是稳定状态。
  • Modifying:变配NAT网关是异步操作,在变配的过程中是Modifying状态。
  • Deleting:删除NAT网关是异步操作,在删除的过程中是Deleting状态。
  • Converting:普通型NAT网关转换到增强型NAT网关是异步操作,在转换过程中是Converting状态。
CreationTime String 2020-06-08T12:20:20Z

创建时间。按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。

VpcId String vpc-bp15zckdt37pq72z****

NAT网关所属的VPC的ID。

NatType String Normal

公网NAT网关的类型,取值:

  • Normal:普通型公网NAT网关。
  • Enhanced:增强型公网NAT网关。
Spec String Small

公网NAT网关的规格,取值:

  • Small:小型。
  • Middle:中型。
  • Large:大型。
DeletionProtection Boolean true

是否开启了删除保护功能,取值:

  • true:已开启。
  • false:未开启。
NetworkType String internet

NAT网关的类型,取值:

  • internet:公网NAT网关。
  • intranet:VPC NAT网关。
SecurityProtectionEnabled Boolean false

是否开启防火墙功能,取值:

  • false:不开启防火墙功能。
  • true:开启防火墙功能。
InstanceChargeType String PostPaid

要查询的NAT网关实例的付费模式,取值:PostPaid(按量付费)。

RegionId String cn-hangzhou

NAT网关的所在地域ID。

EcsMetricEnabled Boolean true

是否开启了网关流量监控功能,取值:

  • true:已开启。
  • false:未开启。
IcmpReplyEnabled Boolean false

是否开启ICMP不代回功能,取值:

  • true:已开启。
  • false:未开启。
Description String NAT

NAT网关的描述信息。

ExpiredTime String 2020-08-26T16:00Z

NAT网关的过期时间。

ResourceGroupId String rg-bp67acfmxazb4ph****

资源组ID。

NatGatewayId String ngw-bp1047e2d4z7kf2ki****

NAT网关的ID。

InternetChargeType String PayBySpec

NAT网关的计费类型,取值:

  • PayBySpec:按固定规格计费。
  • PayByLcu:按使用量计费。
BusinessStatus String Normal

NAT网关的业务状态,取值:

  • Normal:正常。
  • FinancialLocked:欠费锁定状态。
Name String abc

NAT网关实例名称。

IpLists Array of IpList

NAT网关的IP信息列表。

IpList
IpAddress String 116.62.XX.XX

NAT网关绑定的弹性公网IP的地址。

SnatEntryEnabled Boolean false

已经用于DNAT条目的IP,是否还可用于SNAT条目,取值:

  • true:还可用于SNAT条目。
  • false:不可用于SNAT条目。
PrivateIpAddress String 192.168.XX.XX

NAT网关的私网IP地址。

ForwardTableIds Array of String ftb-uf6gj3mhsg94qsqst****

DNAT表ID。

SnatTableIds Array of String stb-uf6dalcdu0krz423p****

NAT网关的SNAT表ID。

FullNatTableIds Array of String fulltb-gw88z7hhlv43rmb26****

FULLNAT表ID。

NatGatewayPrivateInfo Object

增强型公网NAT网关的私网信息。

说明 NatType取值为Normal时,该列表中返回的参数均为空值。
VswitchId String vsw-bp1s2laxhdf9ayjbo****

NAT网关所属的交换机ID。

EniInstanceId String 10

弹性网卡实例ID。

MaxBandwidth Integer 5120

最大带宽值,单位为Mbps。

PrivateIpAddress String 192.168.XX.XX

私网IP地址。

IzNo String cn-hangzhou-b

NAT网关所属的可用区。

EniType String Secondary

弹性网卡类型,取值:

  • Primary:主网卡。
  • Secondary:辅助弹性网卡。
PrivateLinkEnabled Boolean true

是否支持私网连接,取值:

  • true:支持私网连接。
  • false:不支持私网连接。
PrivateLinkMode String FullNat

私网连接服务转化模式,取值:

  • FullNat:使用FULLNAT模式。
  • Geneve:使用Geneve模式。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeNatGateways
&RegionId=cn-hangzhou
&NatGatewayId=ngw-bp1uewa15k4iy5770****
&VpcId=vpc-bp15zckdt37pq72z****
&Name=test
&InstanceChargeType=PostPaid
&Spec=Small
&NatType=Normal
&ResourceGroupId=rg-bp67acfmxazb4ph****
&PageNumber=10
&PageSize=1
&DryRun=true
&Status=Available
&NetworkType=internet
&ZoneId=cn-hangzhou-b
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeNatGatewaysResponse>
    <PageSize>10</PageSize>
    <RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF	</RequestId>
    <PageNumber>10</PageNumber>
    <TotalCount>10</TotalCount>
    <NatGateways>
        <Status>Creating</Status>
        <CreationTime>2020-06-08T12:20:20Z</CreationTime>
        <VpcId>vpc-bp15zckdt37pq72z****</VpcId>
        <NatType>Normal</NatType>
        <Spec>Small</Spec>
        <DeletionProtection>true</DeletionProtection>
        <NetworkType>internet</NetworkType>
        <SecurityProtectionEnabled>false</SecurityProtectionEnabled>
        <InstanceChargeType>PostPaid</InstanceChargeType>
        <RegionId>cn-hangzhou</RegionId>
        <EcsMetricEnabled>true</EcsMetricEnabled>
        <IcmpReplyEnabled>false</IcmpReplyEnabled>
        <Description>NAT</Description>
        <ExpiredTime>2020-08-26T16:00Z</ExpiredTime>
        <ResourceGroupId>rg-bp67acfmxazb4ph****</ResourceGroupId>
        <NatGatewayId>ngw-bp1047e2d4z7kf2ki****</NatGatewayId>
        <InternetChargeType>PayBySpec</InternetChargeType>
        <BusinessStatus>Normal</BusinessStatus>
        <Name>abc</Name>
        <IpLists>
            <IpAddress>116.62.XX.XX</IpAddress>
            <SnatEntryEnabled>false</SnatEntryEnabled>
            <PrivateIpAddress>192.168.XX.XX</PrivateIpAddress>
        </IpLists>
        <ForwardTableIds>ftb-uf6gj3mhsg94qsqst****</ForwardTableIds>
        <SnatTableIds>stb-uf6dalcdu0krz423p****</SnatTableIds>
        <FullNatTableIds>fulltb-gw88z7hhlv43rmb26****</FullNatTableIds>
        <NatGatewayPrivateInfo>
            <VswitchId>vsw-bp1s2laxhdf9ayjbo****</VswitchId>
            <EniInstanceId>10</EniInstanceId>
            <MaxBandwidth>5120</MaxBandwidth>
            <PrivateIpAddress>192.168.XX.XX</PrivateIpAddress>
            <IzNo>cn-hangzhou-b</IzNo>
            <EniType>Secondary</EniType>
        </NatGatewayPrivateInfo>
        <PrivateLinkEnabled>true</PrivateLinkEnabled>
        <PrivateLinkMode>FullNat</PrivateLinkMode>
    </NatGateways>
</DescribeNatGatewaysResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : 10,
  "RequestId" : "4EC47282-1B74-4534-BD0E-403F3EE64CAF\t",
  "PageNumber" : 10,
  "TotalCount" : 10,
  "NatGateways" : [ {
    "Status" : "Creating",
    "CreationTime" : "2020-06-08T12:20:20Z",
    "VpcId" : "vpc-bp15zckdt37pq72z****",
    "NatType" : "Normal",
    "Spec" : "Small",
    "DeletionProtection" : true,
    "NetworkType" : "internet",
    "SecurityProtectionEnabled" : false,
    "InstanceChargeType" : "PostPaid",
    "RegionId" : "cn-hangzhou",
    "EcsMetricEnabled" : true,
    "IcmpReplyEnabled" : false,
    "Description" : "NAT",
    "ExpiredTime" : "2020-08-26T16:00Z",
    "ResourceGroupId" : "rg-bp67acfmxazb4ph****",
    "NatGatewayId" : "ngw-bp1047e2d4z7kf2ki****",
    "InternetChargeType" : "PayBySpec",
    "BusinessStatus" : "Normal",
    "Name" : "abc",
    "IpLists" : [ {
      "IpAddress" : "116.62.XX.XX",
      "SnatEntryEnabled" : false,
      "PrivateIpAddress" : "192.168.XX.XX"
    } ],
    "ForwardTableIds" : [ "ftb-uf6gj3mhsg94qsqst****" ],
    "SnatTableIds" : [ "stb-uf6dalcdu0krz423p****" ],
    "FullNatTableIds" : [ "fulltb-gw88z7hhlv43rmb26****" ],
    "NatGatewayPrivateInfo" : {
      "VswitchId" : "vsw-bp1s2laxhdf9ayjbo****",
      "EniInstanceId" : "10",
      "MaxBandwidth" : 5120,
      "PrivateIpAddress" : "192.168.XX.XX",
      "IzNo" : "cn-hangzhou-b",
      "EniType" : "Secondary"
    },
    "PrivateLinkEnabled" : true,
    "PrivateLinkMode" : "FullNat"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidRegionId.NotFound The specified RegionId does not exist in our records. 指定的regionid不存在。

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