调用DescribeNatGateways查询已创建的NAT网关_专有网络VPC(VPC)-阿里云帮助中心

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

接口说明

本接口支持查询公网 NAT 网关或 VPC NAT 网关的详细信息，文中出现的“NAT 网关”不做具体的区分。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	要查询的 NAT 网关所在的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou
NatGatewayId	string	否	要查询的 NAT 网关的 ID。	ngw-bp1uewa15k4iy5770****
VpcId	string	否	要查询的 NAT 网关所属 VPC 的 ID。	vpc-bp15zckdt37pq72z****
Name	string	否	要查询的 NAT 网关的名称。名称长度为 1～128 个字符，不能以`http://`或`https://`开头。	test
InstanceChargeType	string	否	要查询的 NAT 网关实例的付费模式，取值： PostPaid：按量付费。 PrePaid：存量包年包月付费模式。目前包年包月付费模式已停止新购。	PostPaid
Spec	string	否	公网 NAT 网关的规格，仅当 InstanceChargeType 为 PrePaid（存量包年包月公网 NAT 网关）支持按固定规格创建 NAT 网关，取值： Small（默认值）：小型。 Middle：中型。 Large：大型。	中国站示例值：Small，国际站示例值：无需填写
NatType	string	否	NAT 网关的类型，取值：Enhanced，增强型。	Enhanced
ResourceGroupId	string	否	要查询的 NAT 网关所属的资源组 ID。	rg-bp67acfmxazb4ph****
PageNumber	integer	否	列表的页码，默认值为 1。	10
PageSize	integer	否	分页查询时每页的行数，最大值为 50，默认值为 10。	1
DryRun	boolean	否	是否只预检此次请求，取值： true：发送检查请求，不会查询资源状况。检查项包括 AccessKey 是否有效、RAM 用户的授权情况和是否填写了必需参数。如果检查不通过，则返回对应错误。如果检查通过，会返回错误码`DryRunOperation`。 false（默认值）：发送正常请求，通过检查后返回 2xx HTTP 状态码并直接查询资源状况。	false
Status	string	否	要查询的 NAT 网关的状态，取值： Creating：创建 NAT 网关是异步操作，在创建完成之前是 Creating 状态。 Available：NAT 网关创建完成后的状态，是稳定状态。 Modifying：变配 NAT 网关是异步操作，在变配的过程中是 Modifying 状态。 Deleting：删除 NAT 网关是异步操作，在删除的过程中是 Deleting 状态。 Converting：普通型 NAT 网关转换到增强型 NAT 网关是异步操作，在转换过程中是 Converting 状态。	Available
NetworkType	string	否	要查询的 NAT 网关的类型，取值： internet：公网 NAT 网关。 intranet：VPC NAT 网关。	internet
Tag	array<object>	否	标签列表。
	object	否	标签列表。
Key	string	否	NAT 网关实例的标签键。最多支持输入 20 个标签键。标签键最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	KeyTest
Value	string	否	NAT 网关实例的标签值。最多支持输入 20 个标签值。标签值最多支持 128 个字符，不能以`aliyun`或`acs:`开头，不能包含`http://`和`https://`。	valueTest
ZoneId	string	否	NAT 网关所在的可用区 ID。	cn-hangzhou-b

返回参数

名称	类型	描述	示例值
	object	每页包含的条目数。
PageSize	integer	每页包含的条目数。	10
RequestId	string	请求 ID。	4EC47282-1B74-4534-BD0E-403F3EE64CAF
PageNumber	integer	当前页码。	10
TotalCount	integer	查询的 NAT 网关列表条目数。	1
NatGateways	array<object>	NAT 网关的详细信息。
	object	NAT 网关的详细信息。
Status	string	NAT 网关的状态，取值： Creating：创建 NAT 网关是异步操作，在创建完成之前是 Creating 状态。 Available：NAT 网关创建完成后的状态，是稳定状态。 Modifying：变配 NAT 网关是异步操作，在变配的过程中是 Modifying 状态。 Deleting：删除 NAT 网关是异步操作，在删除的过程中是 Deleting 状态。 Converting：普通型 NAT 网关转换到增强型 NAT 网关是异步操作，在转换过程中是 Converting 状态。	Creating
CreationTime	string	NAT 网关的创建时间。	2021-06-08T12:20:20Z
VpcId	string	NAT 网关所属的 VPC 的 ID。	vpc-bp15zckdt37pq72z****
NatType	string	NAT 网关的类型，取值：Enhanced，增强型。	Enhanced
AutoPay	boolean	是否自动支付订单。取值： false：不自动支付订单。 true：自动支付订单。	false
Spec	string	公网 NAT 网关的规格，仅当 InstanceChargeType 为 PrePaid（存量包年包月公网 NAT 网关）支持按固定规格创建 NAT 网关，取值： Small：小型。 Middle：中型。 Large：大型。当 InternetChargeType 为 PayByLcu 时，返回值为空。	Small
DeletionProtection	boolean	是否开启了删除保护功能，取值： true：已开启。 false：未开启。	true
NetworkType	string	NAT 网关的类型，取值： internet：公网 NAT 网关。 intranet：VPC NAT 网关。	internet
SecurityProtectionEnabled	boolean	是否开启防火墙功能，取值： false：不开启防火墙功能。 true：开启防火墙功能。	false
InstanceChargeType	string	要查询的 NAT 网关实例的付费模式，取值： PostPaid：按量付费。 PrePaid：包年包月。	PostPaid
RegionId	string	NAT 网关的所在地域 ID。	cn-hangzhou
EcsMetricEnabled	boolean	是否开启了网关流量监控功能，取值： true：已开启。 false：未开启。	true
IcmpReplyEnabled	boolean	是否开启 ICMP 代回。取值： true（默认值）：开启。 false：不开启。	true
Description	string	NAT 网关的描述信息。	NAT
ExpiredTime	string	NAT 网关的过期时间。	2021-08-26T16:00Z
ResourceGroupId	string	资源组 ID。	rg-bp67acfmxazb4ph****
NatGatewayId	string	NAT 网关的 ID。	ngw-bp1047e2d4z7kf2ki****
InternetChargeType	string	NAT 网关的计费类型，取值： PayBySpec：按固定规格计费。 PayByLcu：按使用量计费。	PayByLcu
BusinessStatus	string	NAT 网关的业务状态，取值： Normal：正常。 FinancialLocked：欠费锁定状态。	Normal
Name	string	NAT 网关实例名称。	abc
IpLists	array<object>	公网 NAT 网关绑定的 EIP 列表。
	object	NAT 网关的 IP 信息列表。
UsingStatus	string	公网 NAT 网关实例绑定的 EIP 的关联关系。取值： UsedByForwardTable：使用该 EIP 配置了 DNAT 规则。 UsedBySnatTable：使用该 EIP 配置了 SNAT 规则。 UsedByForwardSnatTable：使用该 EIP 配置了 DNAT 和 SNAT 规则。 Idle：闲置状态，未配置 DNAT 和 SNAT 规则。	UsedByForwardTable
IpAddress	string	NAT 网关绑定的 EIP 的 IP 地址。	116.62.XX.XX
SnatEntryEnabled	boolean	已经用于 DNAT 条目的 IP，是否还可用于 SNAT 条目，取值： true：还可用于 SNAT 条目。 false：不可用于 SNAT 条目。	false
AllocationId	string	NAT 网关绑定的 EIP 的实例 ID。	eip-m5egzuvp3dgixen6****
PrivateIpAddress	string	NAT 网关的私网 IP 地址。	192.168.XX.XX
ForwardTableIds	array	NAT 网关的私网 IP 地址。
	string	DNAT 表 ID。	ftb-uf6gj3mhsg94qsqst****
SnatTableIds	array	NAT 网关的 SNAT 表 ID。
	string	NAT 网关的 SNAT 表 ID。	stb-uf6dalcdu0krz423p****
FullNatTableIds	array	FULLNAT 表 ID。
	string	FULLNAT 表 ID。	fulltb-gw88z7hhlv43rmb26****
NatGatewayPrivateInfo	object	增强型公网 NAT 网关的私网信息。说明 NatType 取值为 Normal 时，该列表中返回的参数均为空值。
VswitchId	string	NAT 网关所属的交换机 ID。	vsw-bp1s2laxhdf9ayjbo****
EniInstanceId	string	弹性网卡实例 ID。	eni-m5eg4ozy5st8q3q4****
MaxBandwidth	integer	最大带宽值，单位为 Mbps。	5120
MaxSessionQuota	integer	NAT 网关的并发连接数。单位：个。	2000000
MaxSessionEstablishRate	integer	NAT 网关的新建连接数。单位：个/秒。	100000
PrivateIpAddress	string	私网 IP 地址。	192.168.XX.XX
IzNo	string	NAT 网关所属的可用区。	cn-hangzhou-b
EniType	string	弹性网卡与 NAT 网关的绑定模式，取值： indirect：非直通模式。返回值为空：直通模式。	indirect
PrivateLinkEnabled	boolean	是否支持私网连接，取值： true：支持私网连接。 false：不支持私网连接。	true
PrivateLinkMode	string	私网连接服务转化模式，取值： FullNat：使用 FULLNAT 模式。 Geneve：使用 Geneve 模式。	FullNat
EipBindMode	string	NAT 网关的 EIP 绑定模式，取值： MULTI_BINDED：多 EIP 网卡可见模式。 NAT：EIP 普通模式，兼容 IPv4 网关。说明 NAT 网关的 EIP 绑定模式为 EIP 普通模式时，EIP 将占用 NAT 网关所在交换机的一个私网 IP，请确保 NAT 网关所在交换机内私网 IP 地址充足，如果 NAT 网关所在的交换机没有可用的空闲私网地址时，将无法绑定新的 EIP。NAT 网关的 EIP 绑定模式为 EIP 普通模式时，NAT 网关支持绑定的 EIP 数量上限为 50 个。	MULTI_BINDED
Tags	array<object>	标签列表。
	object	标签列表。
TagKey	string	实例的标签键。	KeyTest
TagValue	string	实例的标签值。	valueTest
EnableSessionLog	string	是否开启会话日志，取值： true：已开启会话日志。 false：已关闭会话日志。	true

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "PageNumber": 10,
  "TotalCount": 1,
  "NatGateways": {
    "NatGateway": [
      {
        "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": true,
        "Description": "NAT",
        "ExpiredTime": "2021-08-26T16:00Z",
        "ResourceGroupId": "rg-bp67acfmxazb4ph****",
        "NatGatewayId": "ngw-bp1047e2d4z7kf2ki****",
        "InternetChargeType": "PayByLcu",
        "BusinessStatus": "Normal",
        "Name": "abc",
        "IpLists": {
          "IpList": [
            {
              "UsingStatus": "UsedByForwardTable",
              "IpAddress": "116.62.XX.XX",
              "SnatEntryEnabled": false,
              "AllocationId": "eip-m5egzuvp3dgixen6****",
              "PrivateIpAddress": "192.168.XX.XX"
            }
          ]
        },
        "ForwardTableIds": {
          "ForwardTableId": [
            "ftb-uf6gj3mhsg94qsqst****"
          ]
        },
        "SnatTableIds": {
          "SnatTableId": [
            "stb-uf6dalcdu0krz423p****"
          ]
        },
        "FullNatTableIds": {
          "FullNatTableId": [
            "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": {
          "Tag": [
            {
              "TagKey": "KeyTest",
              "TagValue": "valueTest"
            }
          ]
        },
        "EnableSessionLog": "true"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.	指定的RegionId不存在。
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	内部错误

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

变更历史

变更时间	变更内容概要	操作
2024-05-07	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-01-18	OpenAPI 描述信息更新、OpenAPI 错误码发生变更	查看变更详情
2023-03-01	OpenAPI 错误码发生变更	查看变更详情
2022-08-26	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2021-11-17	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2021-11-17	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情