调用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:按量付费。
  • 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:辅