调用DescribeNatGateways接口以列表形式查询指定地域指定条件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网关的名称。

名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、下划线(_)和短划线(-)。

如果没有指定该参数,系统会为NAT网关创建默认的名称。

InstanceChargeType String PostPaid

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

Spec String 中国站示例值:Small,国际站示例值:无需填写

NAT网关的规格,该参数不填。

NatType String Enhanced

NAT网关的类型,取值:Enhanced,增强型。

ResourceGroupId String rg-bp67acfmxazb4ph****

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

PageNumber Integer 10

列表的页码,默认值为1

PageSize Integer 1

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

DryRun Boolean false

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

  • 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网关。
Tag.N.Key String KeyTest

NAT网关实例的标签键。最多支持输入20个标签键。

标签键最多支持64个字符,不能以aliyunacs:开头,不能包含http://或者https://

Tag.N.Value String valueTest

NAT网关实例的标签值。最多支持输入20个标签值。

标签值最多支持128个字符,不能以aliyunacs:开头,不能包含http://https://

ZoneId String cn-hangzhou-b

NAT网关所在的可用区ID。

返回数据

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

每页包含的条目数。

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

请求ID。

PageNumber Integer 10

当前页码。

TotalCount Integer 1

查询的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 2021-06-08T12:20:20Z

NAT网关的创建时间。

VpcId String vpc-bp15zckdt37pq72z****

NAT网关所属的VPC的ID。

NatType String Enhanced

NAT网关的类型,取值:Enhanced,增强型。

AutoPay Boolean false

是否自动支付订单。取值:

  • false:不自动支付订单。
  • true:自动支付订单。
Spec String Small

NAT网关的规格,该参数返回值为空。

InternetChargeTypePayByLcu时,返回值为空。

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 2021-08-26T16:00Z

NAT网关的过期时间。

ResourceGroupId String rg-bp67acfmxazb4ph****

资源组ID。

NatGatewayId String ngw-bp1047e2d4z7kf2ki****

NAT网关的ID。

InternetChargeType String PayByLcu

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

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

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

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

NAT网关实例名称。

IpLists Array of IpList

公网NAT网关绑定的EIP列表。

IpList
UsingStatus String UsedByForwardTable

公网NAT网关实例绑定的EIP的关联关系。取值:

  • UsedByForwardTable:使用该EIP配置了DNAT规则。
  • UsedBySnatTable:使用该EIP配置了SNAT规则。
  • UsedByForwardSnatTable:使用该EIP配置了DNAT和SNAT规则。
  • Idle:闲置状态,未配置DNAT和SNAT规则。
IpAddress String 116.62.XX.XX

NAT网关绑定的EIP的IP地址。

SnatEntryEnabled Boolean false

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

  • true:还可用于SNAT条目。
  • false:不可用于SNAT条目。
AllocationId String eip-m5egzuvp3dgixen6****

NAT网关绑定的EIP的实例ID。

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 eni-m5eg4ozy5st8q3q4****

弹性网卡实例ID。

MaxBandwidth Integer 5120

最大带宽值,单位为Mbps。

MaxSessionQuota Integer 2000000

NAT网关的并发连接数。单位:个。

MaxSessionEstablishRate Integer 100000

NAT网关的新建连接数。单位:个/秒。

PrivateIpAddress String 192.168.XX.XX

私网IP地址。

IzNo String cn-hangzhou-b

NAT网关所属的可用区。

EniType String indirect

弹性网卡与NAT网关的绑定模式,取值:

  • indirect:非直通模式。
  • 返回值为空:直通模式。
PrivateLinkEnabled Boolean true

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

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

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

  • FullNat:使用FULLNAT模式。
  • Geneve:使用Geneve模式。
EipBindMode String MULTI_BINDED

NAT网关的EIP绑定模式,取值:

  • MULTI_BINDED:多EIP网卡可见模式。
  • NAT:EIP普通模式,兼容IPv4网关。
说明 说明 NAT网关的EIP绑定模式为EIP普通模式时,EIP将占用NAT网关所在交换机的一个私网IP,请确保NAT网关所在交换机内私网IP地址充足,如果NAT网关所在的交换机没有可用的空闲私网地址时,将无法绑定新的EIP。NAT网关的EIP绑定模式为EIP普通模式时,NAT网关支持绑定的EIP数量上限为50个。
Tags Array of Tag

标签列表。

Tag
TagKey String KeyTest

实例的标签键。

TagValue String valueTest

实例的标签值。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeNatGateways
&RegionId=cn-hangzhou
&NatGatewayId=ngw-bp1uewa15k4iy5770****
&VpcId=vpc-bp15zckdt37pq72z****
&Name=test
&InstanceChargeType=PostPaid
&Spec=中国站示例值:Small,国际站示例值:无需填写
&NatType=Enhanced
&ResourceGroupId=rg-bp67acfmxazb4ph****
&PageNumber=10
&PageSize=1
&DryRun=false
&Status=Available
&NetworkType=internet
&Tag=[{}]
&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>1</TotalCount>
    <NatGateways>
        <Status>Creating</Status>
        <CreationTime>2021-06-08T12:20:20Z</CreationTime>
        <VpcId>vpc-bp15zckdt37pq72z****</VpcId>
        <NatType>Enhanced</NatType>
        <AutoPay>false</AutoPay>
        <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>2021-08-26T16:00Z</ExpiredTime>
        <ResourceGroupId>rg-bp67acfmxazb4ph****</ResourceGroupId>
        <NatGatewayId>ngw-bp1047e2d4z7kf2ki****</NatGatewayId>
        <InternetChargeType>PayByLcu</InternetChargeType>
        <BusinessStatus>Normal</BusinessStatus>
        <Name>abc</Name>
        <IpLists>
            <UsingStatus>UsedByForwardTable</UsingStatus>
            <IpAddress>116.62.XX.XX</IpAddress>
            <SnatEntryEnabled>false</SnatEntryEnabled>
            <AllocationId>eip-m5egzuvp3dgixen6****</AllocationId>
            <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>eni-m5eg4ozy5st8q3q4****</EniInstanceId>
            <MaxBandwidth>5120</MaxBandwidth>
            <MaxSessionQuota>2000000</MaxSessionQuota>
            <MaxSessionEstablishRate>100000</MaxSessionEstablishRate>
            <PrivateIpAddress>192.168.XX.XX</PrivateIpAddress>
            <IzNo>cn-hangzhou-b</IzNo>
            <EniType>indirect</EniType>
        </NatGatewayPrivateInfo>
        <PrivateLinkEnabled>true</PrivateLinkEnabled>
        <PrivateLinkMode>FullNat</PrivateLinkMode>
        <EipBindMode>MULTI_BINDED</EipBindMode>
        <Tags>
            <TagKey>KeyTest</TagKey>
            <TagValue>valueTest</TagValue>
        </Tags>
    </NatGateways>
</DescribeNatGatewaysResponse>

JSON格式

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

{
  "PageSize" : 10,
  "RequestId" : "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "PageNumber" : 10,
  "TotalCount" : 1,
  "NatGateways" : [ {
    "Status" : "Creating",
    "CreationTime" : "2021-06-08T12:20:20Z",
    "VpcId" : "vpc-bp15zckdt37pq72z****",
    "NatType" : "Enhanced",
    "AutoPay" : false,
    "Spec" : "Small",
    "DeletionProtection" : true,
    "NetworkType" : "internet",
    "SecurityProtectionEnabled" : false,
    "InstanceChargeType" : "PostPaid",
    "RegionId" : "cn-hangzhou",
    "EcsMetricEnabled" : true,
    "IcmpReplyEnabled" : false,
    "Description" : "NAT",
    "ExpiredTime" : "2021-08-26T16:00Z",
    "ResourceGroupId" : "rg-bp67acfmxazb4ph****",
    "NatGatewayId" : "ngw-bp1047e2d4z7kf2ki****",
    "InternetChargeType" : "PayByLcu",
    "BusinessStatus" : "Normal",
    "Name" : "abc",
    "IpLists" : [ {
      "UsingStatus" : "UsedByForwardTable",
      "IpAddress" : "116.62.XX.XX",
      "SnatEntryEnabled" : false,
      "AllocationId" : "eip-m5egzuvp3dgixen6****",
      "PrivateIpAddress" : "192.168.XX.XX"
    } ],
    "ForwardTableIds" : [ "ftb-uf6gj3mhsg94qsqst****" ],
    "SnatTableIds" : [ "stb-uf6dalcdu0krz423p****" ],
    "FullNatTableIds" : [ "fulltb-gw88z7hhlv43rmb26****" ],
    "NatGatewayPrivateInfo" : {
      "VswitchId" : "vsw-bp1s2laxhdf9ayjbo****",
      "EniInstanceId" : "eni-m5eg4ozy5st8q3q4****",
      "MaxBandwidth" : 5120,
      "MaxSessionQuota" : 2000000,
      "MaxSessionEstablishRate" : 100000,
      "PrivateIpAddress" : "192.168.XX.XX",
      "IzNo" : "cn-hangzhou-b",
      "EniType" : "indirect"
    },
    "PrivateLinkEnabled" : true,
    "PrivateLinkMode" : "FullNat",
    "EipBindMode" : "MULTI_BINDED",
    "Tags" : [ {
      "TagKey" : "KeyTest",
      "TagValue" : "valueTest"
    } ]
  } ]
}

错误码

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

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