文档

GetNatGatewayAttribute - 查看单个NAT网关实例详细信息

更新时间:

调用GetNatGatewayAttribute接口查询单个NAT网关实例的信息。

接口说明

本接口可以查询单个公网 NAT 网关或 VPC NAT 网关的信息,文中出现的“NAT 网关”不做具体的区分。

调试

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

授权信息

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

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

请求参数

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

NAT 网关所属的地域 ID。

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

cn-qingdao
NatGatewayIdstring

NAT 网关实例 ID。

ngw-bp1b0lic8uz4r6vf2****

返回参数

名称类型描述示例值
object
VpcIdstring

NAT 网关实例所属 VPC 的 ID。

vpc-bp15zckdt37pq72z****
CreationTimestring

NAT 网关的创建时间。格式为:YYYY-MM-DDThh:mm:ssZ。

2021-12-08T12:20:20Z
Statusstring

NAT 网关的状态。取值:

  • Creating:创建中。创建 NAT 网关是异步操作,在创建完成之前是 Creating 状态。
  • Available:可用。NAT 网关创建完成后的状态,是稳定状态。
  • Modifying:修改中。变配 NAT 网关是异步操作,在变配的过程中是 Modifying 状态。
  • Deleting:删除中。删除 NAT 网关是异步操作,在删除的过程中是 Deleting 状态。
  • Converting:转换中。普通型 NAT 网关转换到增强型 NAT 网关是异步操作,在转换过程中是 Converting 状态。
Available
NatTypestring

公网 NAT 网关的类型,当前取值为 Enhanced,即增强型公网 NAT 网关。

Enhanced
NetworkTypestring

NAT 网关的类型。取值:

  • internet:公网 NAT 网关。
  • intranet:VPC NAT 网关。
internet
RegionIdstring

NAT 网关实例所在的地域 ID。

cn-qingdao
EcsMetricEnabledboolean

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

  • true:开启了网关流量监控功能。
  • false:未开启网关流量监控功能。
true
RequestIdstring

请求 ID。

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

NAT 网关实例的描述。

NAT
ExpiredTimestring

NAT 网关实例的过期时间。

2021-12-26T12:20:20Z
ResourceGroupIdstring

资源组 ID。

rg-bp67acfmxazb4ph****
NatGatewayIdstring

NAT 网关实例的 ID。

ngw-bp1047e2d4z7kf2ki****
BusinessStatusstring

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

  • Normal:正常。
  • FinancialLocked:欠费锁定状态。
Normal
Namestring

NAT 网关实例名称。

abc
ForwardTableobject

DNAT 列表的信息。

ForwardTableIdstring

DNAT 表的 ID。

ftb-uf6gj3mhsg94qsqst****
ForwardEntryCountinteger

DNAT 条目的个数。

1
SnatTableobject

SNAT 列表信息。

SnatEntryCountinteger

SANT 条目的个数。

1
SnatTableIdstring

SNAT 列表的 ID。

stb-SnatTableIds****
FullNatTableobject

FULLNAT 列表的信息。

FullNatEntryCountlong

FULLNAT 条目的个数。

1
FullNatTableIdstring

FULLNAT 表的 ID。

fulltb-gw88z7hhlv43rmb26****
BillingConfigobject

账单配置信息。

InternetChargeTypestring

NAT 网关实例的计费类型。取值:

  • PayBySpec:按固定规格计费。
  • PayByLcu:按使用量计费。
PayBySpec
AutoPaystring

是否自动付费,当 InstanceChargeType 参数的值为 PrePaid 时,返回以下值:

  • false:不开启自动付费,生成订单后需要到订单中心完成支付。

  • true:开启自动付费,自动支付订单。

InstanceChargeType 参数的值为 PostPaid 时,返回值为空。

false
Specstring

公网 NAT 网关实例的规格,且当 InternetChargeTypePayBySpec 时,返回以下值:

  • Small:小型。
  • Middle:中型。
  • Large:大型。 当 InternetChargeTypePayByLcu 时,返回值为空。
Small
InstanceChargeTypestring

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

  • PostPaid:按量付费。

  • PrePaid:包年包月。

PostPaid
PrivateInfoobject

NAT 网关实例的私网信息。

MaxBandwidthinteger

最大带宽值,单位为 Mbps。

5120
VswitchIdstring

NAT 网关实例所属的交换机 ID。

vsw-bp1s2laxhdf9ayjbo***
PrivateIpAddressstring

私网 IP 地址。

192.168.XX.XX
IzNostring

NAT 网关实例所属的可用区。

cn-qingdao-b
EniInstanceIdstring

弹性网卡实例 ID。

eni-bp1cmgtoaka8vfyg****
DeletionProtectionInfoobject

删除保护信息。

Enabledboolean

是否开启删除保护功能。

  • true:开启了删除保护功能。
  • false:未开启删除保护功能。
true
IpListobject []

公网 NAT 网关绑定的弹性公网 IP 列表。

UsingStatusstring

公网 NAT 网关实例绑定的弹性公网 IP 的关联关系。

  • idle:弹性公网 IP 未关联 SNAT 条目或 DNAT 条目。
  • UsedBySnatTable:弹性公网 IP 已关联 SNAT 条目。
  • UsedByForwardTable:弹性公网 IP 已关联 DNAT 条目。
idle
IpAddressstring

弹性公网 IP 的地址。

116.33.XX.XX
AllocationIdstring

弹性公网 IP 的实例 ID。

eip-bp13e9i2qst4g6jzi****
PrivateLinkEnabledboolean

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

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

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

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

是否开启会话日志,取值:

  • true:已开启会话日志。

  • false:已关闭会话日志。

true
LogDeliveryobject

会话日志配置信息。

LogDeliveryTypestring

会话日志投递目的类型。取值: sls,阿里云日志服务 SLS。

sls
LogDestinationstring

会话日志写入目的地址。

acs:log:cn-hangzhou:0000:project/nat_session_log_project/logstore/session_log_test
DeliveryStatusstring

会话日志写入状态。取值:

  • Succsess:成功。
  • Failure:失败。
Failure
DeliverLogsErrorMessagestring

会话日志写入失败的错误信息。

LogStoreNotExist: logstore session_log_test does not exist

示例

正常返回示例

JSON格式

{
  "VpcId": "vpc-bp15zckdt37pq72z****",
  "CreationTime": "2021-12-08T12:20:20Z",
  "Status": "Available",
  "NatType": "Enhanced",
  "NetworkType": "internet",
  "RegionId": "cn-qingdao",
  "EcsMetricEnabled": true,
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "Description": "NAT",
  "ExpiredTime": "2021-12-26T12:20:20Z",
  "ResourceGroupId": "rg-bp67acfmxazb4ph****",
  "NatGatewayId": "ngw-bp1047e2d4z7kf2ki****",
  "BusinessStatus": "Normal",
  "Name": "abc",
  "ForwardTable": {
    "ForwardTableId": "ftb-uf6gj3mhsg94qsqst****",
    "ForwardEntryCount": 1
  },
  "SnatTable": {
    "SnatEntryCount": 1,
    "SnatTableId": "stb-SnatTableIds****"
  },
  "FullNatTable": {
    "FullNatEntryCount": 1,
    "FullNatTableId": "fulltb-gw88z7hhlv43rmb26****"
  },
  "BillingConfig": {
    "InternetChargeType": "PayBySpec",
    "AutoPay": "false",
    "Spec": "Small",
    "InstanceChargeType": "PostPaid"
  },
  "PrivateInfo": {
    "MaxBandwidth": 5120,
    "VswitchId": "vsw-bp1s2laxhdf9ayjbo***",
    "PrivateIpAddress": "192.168.XX.XX",
    "IzNo": "cn-qingdao-b",
    "EniInstanceId": "eni-bp1cmgtoaka8vfyg****"
  },
  "DeletionProtectionInfo": {
    "Enabled": true
  },
  "IpList": [
    {
      "UsingStatus": "idle",
      "IpAddress": "116.33.XX.XX",
      "AllocationId": "eip-bp13e9i2qst4g6jzi****"
    }
  ],
  "PrivateLinkEnabled": true,
  "PrivateLinkMode": "FullNat",
  "EnableSessionLog": true,
  "LogDelivery": {
    "LogDeliveryType": "sls",
    "LogDestination": "acs:log:cn-hangzhou:0000:project/nat_session_log_project/logstore/session_log_test",
    "DeliveryStatus": "Failure",
    "DeliverLogsErrorMessage": "LogStoreNotExist: logstore session_log_test does not exist"
  }
}

错误码

HTTP status code错误码错误信息描述
404InvalidRegionId.NotFoundThe specified RegionId does not exist in our records.指定的RegionId不存在。

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

变更历史

变更时间变更内容概要操作
2024-05-07OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:404
出参OpenAPI 返回结构发生变更
2023-03-01OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
  • 本页导读 (1)