淘宝开放平台 - 文档中心

使用说明

本接口查询的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：按量付费。 PrePaid：包年包月。说明国际站仅支持 PostPaid（按量付费）。
Spec	String	否	Large	公网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网关。

返回数据


名称	类型	示例值	描述
NatGateways	Array of NatGateway		NAT网关的详细信息。
NatGateway
BusinessStatus	String	Normal	NAT网关的业务状态，取值： Normal：正常。 FinancialLocked：欠费锁定状态。
CreationTime	String	2020-06-08T12:20:20Z	创建时间。按照ISO8601标准表示，并需要使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。
DeletionProtection	Boolean	true	是否开启了删除保护功能，取值： true：已开启。 false：未开启。
Description	String	NAT	NAT网关的描述信息。
EcsMetricEnabled	Boolean	true	是否开启了网关流量监控功能，取值： true：已开启。 false：未开启。
ExpiredTime	String	2020-08-26T16:00Z	NAT网关的过期时间。
ForwardTableIds	List	ftb-uf6gj3mhsg94qsqst****	DNAT表ID。
IcmpReplyEnabled	Boolean	false	是否开启ICMP不代回功能，取值： true：已开启。 false：未开启。
InstanceChargeType	String	PostPaid	NAT网关实例的付费模式，取值： PostPaid：按量付费。 PrePaid：包年包月。说明国际站仅支持 PostPaid（按量付费）。
InternetChargeType	String	PayBySpec	NAT网关的计费类型，取值： PayBySpec：按固定规格计费。 PayByLcu：按使用量计费。
IpLists	Array of IpList		NAT网关的IP信息列表。
IpList
IpAddress	String	116.62.XX.XX	NAT网关绑定的弹性公网IP的地址。
PrivateIpAddress	String	192.168.XX.XX	NAT网关的私网IP地址。
SnatEntryEnabled	Boolean	false	已经用于DNAT条目的IP，是否还可用于SNAT条目，取值： true：还可用于SNAT条目。 false：不可用于SNAT条目。
Name	String	abc	NAT网关实例名称。
NatGatewayId	String	ngw-bp1047e2d4z7kf2ki****	NAT网关的ID。
NatGatewayPrivateInfo	Struct		增强型公网NAT网关的私网信息。说明 NatType取值为 Normal时，该列表中返回的参数均为空值。
EniInstanceId	String	10	弹性网卡实例ID。
EniType	String	Secondary	弹性网卡类型，取值： Primary：主网卡。 Secondary：辅助弹性网卡。
IzNo	String	cn-hangzhou-b	NAT网关所属的可用区。
MaxBandwidth	Integer	5120	最大带宽值，单位为Mbps。
PrivateIpAddress	String	192.168.XX.XX	私网IP地址。
VswitchId	String	vsw-bp1s2laxhdf9ayjbo****	NAT网关所属的交换机ID。
NatType	String	Normal	公网NAT网关的类型，取值： Normal：普通型公网NAT网关。 Enhanced：增强型公网NAT网关。
NetworkType	String	internet	NAT网关的类型，取值： internet：公网NAT网关。 intranet：VPC NAT网关。
RegionId	String	cn-hangzhou	NAT网关的所在地域ID。
ResourceGroupId	String	rg-bp67acfmxazb4ph****	资源组ID。
SecurityProtectionEnabled	Boolean	false	是否开启防火墙功能，取值： false：不开启防火墙功能。 true：开启防火墙功能。
SnatTableIds	List	stb-uf6dalcdu0krz423p****	NAT网关的SNAT表ID。
Spec	String	Small	公网NAT网关的规格，取值： Small：小型。 Middle：中型。 Large：大型。
Status	String	Creating	NAT网关的状态，取值： Creating：创建NAT网关是异步操作，在创建完成之前是Creating状态。 Available：NAT网关创建完成后的状态，是稳定状态。 Modifying：变配NAT网关是异步操作，在变配的过程中是Modifying状态。 Deleting：删除NAT网关是异步操作，在删除的过程中是Deleting状态。 Converting：普通型NAT网关转换到增强型NAT网关是异步操作，在转换过程中是Converting状态。
VpcId	String	vpc-bp15zckdt37pq72z****	NAT网关所属的VPC的ID。
PageNumber	Integer	10	当前页码。
PageSize	Integer	10	每页包含的条目数。
RequestId	String	4EC47282-1B74-4534-BD0E-403F3EE64CAF	请求ID。
TotalCount	Integer	10	列表条目数。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeNatGateways
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

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

JSON格式

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

错误码


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

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

开放平台

专有网络 VPC

DescribeNatGateways

使用说明

调试

请求参数

返回数据

示例

错误码

FAQ