调用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**** |
NAT网关所属的VPC的ID。 |
Name | String | 否 | test |
要查询的NAT网关的名称。 |
InstanceChargeType | String | 否 | PostPaid |
NAT网关实例的付费模式,取值:
说明 国际站仅支持PostPaid(按量付费)。
|
Spec | String | 否 | Large |
NAT网关的规格,取值:
|
NatType | String | 否 | Normal |
NAT网关的类型,取值:
|
ResourceGroupId | String | 否 | rg-bp67acfmxazb4ph**** |
NAT网关所属的资源组ID。 |
PageNumber | Integer | 否 | 10 |
列表的页码,默认值为1。 |
PageSize | Integer | 否 | 1 |
分页查询时每页的行数,最大值为50,默认值为10。 |
DryRun | Boolean | 否 | true |
是否只预检此次请求,取值:
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
NatGateways | Array of NatGateway |
NAT网关的详细信息。 |
|
NatGateway | |||
BusinessStatus | String | Normal |
NAT网关的业务状态。
|
CreationTime | String | 2017-06-08T12:20Z |
创建时间。按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mmZ。 |
DeletionProtection | Boolean | true |
是否开启了删除保护功能。
|
Description | String | NAT |
NAT网关的描述。 |
EcsMetricEnabled | Boolean | true |
是否开启了网关流量监控功能。
|
ExpiredTime | String | 2017-08-26T16:00Z |
NAT网关的过期时间。 |
ForwardTableIds | List | ftb-uf6gj3mhsg94qsqst**** |
DNAT表ID。 |
InstanceChargeType | String | PostPaid |
NAT网关实例的付费模式。
说明 国际站仅支持PostPaid(按量付费)。
|
InternetChargeType | String | PayBySpec |
NAT网关的计费类型。
|
IpLists | Array of IpList |
NAT网关绑定的弹性公网IP。 |
|
IpList | |||
IpAddress | String | 116.62.222.xx |
弹性公网IP的地址。 |
SnatEntryEnabled | Boolean | false |
已经用于DNAT条目的IP,是否还可用于SNAT条目。
|
Name | String | abc |
NAT网关实例名称。 |
NatGatewayId | String | ngw-bp1047e2d4z7kf2ki**** |
NAT网关的ID。 |
NatGatewayPrivateInfo | Struct |
增强型NAT网关的私网信息。 说明 NatType取值为Normal时,该列表中返回的参数均为空值。
|
|
EniInstanceId | String | 10 |
弹性网卡实例ID。 |
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网关的类型。
|
RegionId | String | cn-hangzhou |
NAT网关的所在地域ID。 |
ResourceGroupId | String | rg-bp67acfmxazb4ph**** |
资源组ID。 |
SnatTableIds | List | stb-uf6dalcdu0krz423p**** |
NAT网关的SNAT表ID。 |
Spec | String | Small |
NAT网关的规格。
|
Status | String | Creating |
NAT网关的状态。
|
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)://vpc.aliyuncs.com/?Action=DescribeNatGateways
&RegionId=cn-hangzhou
&<公共请求参数>
正常返回示例
XML
格式
<DescribeNatGatewaysResponse>
<TotalCount>10</TotalCount>
<PageSize>10</PageSize>
<RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF </RequestId>
<PageNumber>10</PageNumber>
<NatGateways>
<NatGateway>
<Status>Initiating</Status>
<Description>NAT</Description>
<ResourceGroupId>rg-bp67acfmxazb4ph****</ResourceGroupId>
<InstanceChargeType>PostPaid</InstanceChargeType>
<DeletionProtection>true</DeletionProtection>
<NatType>Normal</NatType>
<BusinessStatus>Normal</BusinessStatus>
<InternetChargeType>PayBySpec</InternetChargeType>
<Name>abc</Name>
<EcsMetricEnabled>true</EcsMetricEnabled>
<VpcId>vpc-bp15zckdt37pq72z****</VpcId>
<ExpiredTime>2017-08-26T16:00Z</ExpiredTime>
<CreationTime>2017-06-08T12:20Z</CreationTime>
<RegionId>cn-hangzhou</RegionId>
<Spec>Small</Spec>
<NatGatewayId>ngw-bp1047e2d4z7kf2ki****</NatGatewayId>
</NatGateway>
<NatGateway>
<IpLists>
<IpList>
<SnatEntryEnabled>false</SnatEntryEnabled>
<IpAddress>116.62.222.xx</IpAddress>
</IpList>
</IpLists>
</NatGateway>
<NatGateway>
<SnatTableIds>
<SnatTableId>stb-uf6dalcdu0krz423p****</SnatTableId>
</SnatTableIds>
<ForwardTableIds>
<ForwardTableId>ftb-uf6gj3mhsg94qsqst****</ForwardTableId>
</ForwardTableIds>
</NatGateway>
<NatGateway>
<NatGatewayPrivateInfo>
<IzNo>cn-hangzhou-b</IzNo>
<PrivateIpAddress>192.168.xx.xx</PrivateIpAddress>
<MaxBandwidth>5120</MaxBandwidth>
<EniInstanceId>10</EniInstanceId>
<VswitchId>vsw-bp1s2laxhdf9ayjbo****</VswitchId>
</NatGatewayPrivateInfo>
</NatGateway>
</NatGateways>
</DescribeNatGatewaysResponse>
JSON
格式
{
"TotalCount": 10,
"PageSize": 10,
"RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
"PageNumber": 10,
"NatGateways": {
"NatGateway": [
{
"Status": "Initiating",
"Description": "NAT",
"ResourceGroupId": "rg-bp67acfmxazb4ph****",
"InstanceChargeType": "PostPaid",
"DeletionProtection": true,
"NatType": "Normal",
"BusinessStatus": "Normal",
"InternetChargeType": "PayBySpec",
"Name": "abc",
"EcsMetricEnabled": true,
"VpcId": "vpc-bp15zckdt37pq72z****",
"ExpiredTime": "2017-08-26T16:00Z",
"CreationTime": "2017-06-08T12:20Z",
"RegionId": "cn-hangzhou",
"Spec": "Small",
"NatGatewayId": "ngw-bp1047e2d4z7kf2ki****"
},
{
"IpLists": {
"IpList": {
"SnatEntryEnabled": false,
"IpAddress": "116.62.222.xx"
}
}
},
{
"SnatTableIds": {
"SnatTableId": "stb-uf6dalcdu0krz423p****"
},
"ForwardTableIds": {
"ForwardTableId": "ftb-uf6gj3mhsg94qsqst****"
}
},
{
"NatGatewayPrivateInfo": {
"IzNo": "cn-hangzhou-b",
"PrivateIpAddress": "192.168.xx.xx",
"MaxBandwidth": 5120,
"EniInstanceId": 10,
"VswitchId": "vsw-bp1s2laxhdf9ayjbo****"
}
}
]
}
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
404 | InvalidRegionId.NotFound | The specified RegionId does not exist in our records. | 指定的 RegionId 不存在,请您检查此产品在该地域是否可用。 |
访问错误中心查看更多错误码。