文档

DescribeNatGateways - 查询已创建的NAT网关

更新时间:

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

接口说明

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:DescribeNatGatewaysRead
  • NatGateway
    acs:vpc:{#regionId}:{#accountId}:natgateway/*
  • NatGateway
    acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}

请求参数

名称类型必填描述示例值
RegionIdstring

要查询的 NAT 网关所在的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
NatGatewayIdstring

要查询的 NAT 网关的 ID。

ngw-bp1uewa15k4iy5770****
VpcIdstring

要查询的 NAT 网关所属 VPC 的 ID。

vpc-bp15zckdt37pq72z****
Namestring

要查询的 NAT 网关的名称。

名称长度为 1~128 个字符,不能以http://https://开头。

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

test
InstanceChargeTypestring

要查询的 NAT 网关实例的付费模式,取值:

  • PostPaid:按量付费。
  • PrePaid:存量包年包月付费模式。目前包年包月付费模式已停止新购。
PostPaid
Specstring

公网 NAT 网关的规格,仅当 InstanceChargeTypePrePaid(存量包年包月公网 NAT 网关)支持按固定规格创建 NAT 网关,取值:

  • Small(默认值):小型。
  • Middle:中型。
  • Large:大型。
中国站示例值:Small,国际站示例值:无需填写
NatTypestring

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

Enhanced
ResourceGroupIdstring

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

rg-bp67acfmxazb4ph****
PageNumberinteger

列表的页码,默认值为 1

10
PageSizeinteger

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

1
DryRunboolean

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

  • true:发送检查请求,不会查询资源状况。检查项包括 AccessKey 是否有效、RAM 用户的授权情况和是否填写了必需参数。如果检查不通过,则返回对应错误。如果检查通过,会返回错误码DryRunOperation

  • false(默认值):发送正常请求,通过检查后返回 2xx HTTP 状态码并直接查询资源状况。

false
Statusstring

要查询的 NAT 网关的状态,取值:

  • Creating:创建 NAT 网关是异步操作,在创建完成之前是 Creating 状态。

  • Available:NAT 网关创建完成后的状态,是稳定状态。

  • Modifying:变配 NAT 网关是异步操作,在变配的过程中是 Modifying 状态。

  • Deleting:删除 NAT 网关是异步操作,在删除的过程中是 Deleting 状态。

  • Converting:普通型 NAT 网关转换到增强型 NAT 网关是异步操作,在转换过程中是 Converting 状态。

Available
NetworkTypestring

要查询的 NAT 网关的类型,取值:

  • internet:公网 NAT 网关。
  • intranet:VPC NAT 网关。
internet
Tagobject []

标签列表。

Keystring

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

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

KeyTest
Valuestring

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

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

valueTest
ZoneIdstring

NAT 网关所在的可用区 ID。

cn-hangzhou-b

返回参数

名称类型描述示例值
object

每页包含的条目数。

PageSizeinteger

每页包含的条目数。

10
RequestIdstring

请求 ID。

4EC47282-1B74-4534-BD0E-403F3EE64CAF
PageNumberinteger

当前页码。

10
TotalCountinteger

查询的 NAT 网关列表条目数。

1
NatGatewaysobject []

NAT 网关的详细信息。

Statusstring

NAT 网关的状态,取值:

  • Creating:创建 NAT 网关是异步操作,在创建完成之前是 Creating 状态。

  • Available:NAT 网关创建完成后的状态,是稳定状态。

  • Modifying:变配 NAT 网关是异步操作,在变配的过程中是 Modifying 状态。

  • Deleting:删除 NAT 网关是异步操作,在删除的过程中是 Deleting 状态。

  • Converting:普通型 NAT 网关转换到增强型 NAT 网关是异步操作,在转换过程中是 Converting 状态。

Creating
CreationTimestring

NAT 网关的创建时间。

2021-06-08T12:20:20Z
VpcIdstring

NAT 网关所属的 VPC 的 ID。

vpc-bp15zckdt37pq72z****
NatTypestring

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

Enhanced
AutoPayboolean

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

  • false:不自动支付订单。
  • true:自动支付订单。
false
Specstring

公网 NAT 网关的规格,仅当 InstanceChargeTypePrePaid(存量包年包月公网 NAT 网关)支持按固定规格创建 NAT 网关,取值:

  • Small:小型。
  • Middle:中型。
  • Large:大型。

InternetChargeTypePayByLcu 时,返回值为空。

Small
DeletionProtectionboolean

是否开启了删除保护功能,取值:

  • true:已开启。

  • false:未开启。

true
NetworkTypestring

NAT 网关的类型,取值:

  • internet:公网 NAT 网关。

  • intranet:VPC NAT 网关。

internet
SecurityProtectionEnabledboolean

是否开启防火墙功能,取值:

  • false:不开启防火墙功能。

  • true:开启防火墙功能。

false
InstanceChargeTypestring

要查询的 NAT 网关实例的付费模式,取值:

  • PostPaid:按量付费。
  • PrePaid:包年包月。
PostPaid
RegionIdstring

NAT 网关的所在地域 ID。

cn-hangzhou
EcsMetricEnabledboolean

是否开启了网关流量监控功能,取值:

  • true:已开启。

  • false:未开启。

true
IcmpReplyEnabledboolean

是否开启 ICMP 代回。取值:

  • true(默认值):开启。
  • false:不开启。
true
Descriptionstring

NAT 网关的描述信息。

NAT
ExpiredTimestring

NAT 网关的过期时间。

2021-08-26T16:00Z
ResourceGroupIdstring

资源组 ID。

rg-bp67acfmxazb4ph****
NatGatewayIdstring

NAT 网关的 ID。

ngw-bp1047e2d4z7kf2ki****
InternetChargeTypestring

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

  • PayBySpec:按固定规格计费。

  • PayByLcu:按使用量计费。

PayByLcu
BusinessStatusstring

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

  • Normal:正常。

  • FinancialLocked:欠费锁定状态。

Normal
Namestring

NAT 网关实例名称。

abc
IpListsobject []

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

UsingStatusstring

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

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

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

116.62.XX.XX
SnatEntryEnabledboolean

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

  • true:还可用于 SNAT 条目。

  • false:不可用于 SNAT 条目。

false
AllocationIdstring

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

eip-m5egzuvp3dgixen6****
PrivateIpAddressstring

NAT 网关的私网 IP 地址。

192.168.XX.XX
ForwardTableIdsarray

NAT 网关的私网 IP 地址。

string

DNAT 表 ID。

ftb-uf6gj3mhsg94qsqst****
SnatTableIdsarray

NAT 网关的 SNAT 表 ID。

string

NAT 网关的 SNAT 表 ID。

stb-uf6dalcdu0krz423p****
FullNatTableIdsarray

FULLNAT 表 ID。

string

FULLNAT 表 ID。

fulltb-gw88z7hhlv43rmb26****
NatGatewayPrivateInfoobject

增强型公网 NAT 网关的私网信息。

说明 NatType 取值为 Normal 时,该列表中返回的参数均为空值。
VswitchIdstring

NAT 网关所属的交换机 ID。

vsw-bp1s2laxhdf9ayjbo****
EniInstanceIdstring

弹性网卡实例 ID。

eni-m5eg4ozy5st8q3q4****
MaxBandwidthinteger

最大带宽值,单位为 Mbps。

5120
MaxSessionQuotainteger

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

2000000
MaxSessionEstablishRateinteger

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

100000
PrivateIpAddressstring

私网 IP 地址。

192.168.XX.XX
IzNostring

NAT 网关所属的可用区。

cn-hangzhou-b
EniTypestring

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

  • indirect:非直通模式。

  • 返回值为空:直通模式。

indirect
PrivateLinkEnabledboolean

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

  • true:支持私网连接。
  • false:不支持私网连接。
true
PrivateLinkModestring

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

  • FullNat:使用 FULLNAT 模式。
  • Geneve:使用 Geneve 模式。
FullNat
EipBindModestring

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
Tagsobject []

标签列表。

TagKeystring

实例的标签键。

KeyTest
TagValuestring

实例的标签值。

valueTest

示例

正常返回示例

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"
            }
          ]
        }
      }
    ]
  }
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2024-01-18OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:404
    删除错误码:500
2023-03-01OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
    删除错误码:500
2022-08-26OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:Tag
出参OpenAPI 返回结构发生变更
2021-11-17OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
出参OpenAPI 返回结构发生变更
2021-11-17OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈