使用GetNatGatewayAttribute获取单个NAT网关实例信息-NAT网关-阿里云-NAT网关(NAT Gateway)-阿里云帮助中心

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

接口说明

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

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	NAT 网关所属的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-qingdao
NatGatewayId	string	是	NAT 网关实例 ID。	ngw-bp1b0lic8uz4r6vf2****
RegionId	string	是	NAT 网关所属的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-qingdao

返回参数

名称	类型	描述	示例值
	object
VpcId	string	NAT 网关实例所属 VPC 的 ID。	vpc-bp15zckdt37pq72z****
CreationTime	string	NAT 网关的创建时间。格式为：YYYY-MM-DDThh:mm:ssZ。	2021-12-08T12:20:20Z
Status	string	NAT 网关的状态。取值： Creating：创建中。创建 NAT 网关是异步操作，在创建完成之前是 Creating 状态。 Available：可用。NAT 网关创建完成后的状态，是稳定状态。 Modifying：修改中。变配 NAT 网关是异步操作，在变配的过程中是 Modifying 状态。 Deleting：删除中。删除 NAT 网关是异步操作，在删除的过程中是 Deleting 状态。 Converting：转换中。普通型 NAT 网关转换到增强型 NAT 网关是异步操作，在转换过程中是 Converting 状态。	Available
NatType	string	公网 NAT 网关的类型，当前取值为 Enhanced，即增强型 NAT 网关。	Enhanced
NetworkType	string	NAT 网关的类型。取值： internet：公网 NAT 网关。 intranet：VPC NAT 网关。	internet
RegionId	string	NAT 网关实例所在的地域 ID。	cn-qingdao
EcsMetricEnabled	boolean	是否开启了网关流量监控功能。取值： true：开启了网关流量监控功能。 false：未开启网关流量监控功能。	true
RequestId	string	请求 ID。	4EC47282-1B74-4534-BD0E-403F3EE64CAF
Description	string	NAT 网关实例的描述。	NAT
ExpiredTime	string	NAT 网关实例的过期时间。	2021-12-26T12:20:20Z
ResourceGroupId	string	资源组 ID。	rg-bp67acfmxazb4ph****
NatGatewayId	string	NAT 网关实例的 ID。	ngw-bp1047e2d4z7kf2ki****
BusinessStatus	string	NAT 网关的业务状态。取值： Normal：正常。 FinancialLocked：欠费锁定状态。	Normal
Name	string	NAT 网关实例名称。	abc
ForwardTable	object	DNAT 列表的信息。
ForwardTableId	string	DNAT 表的 ID。	ftb-uf6gj3mhsg94qsqst****
ForwardEntryCount	integer	DNAT 条目的个数。	1
SnatTable	object	SNAT 列表信息。
SnatEntryCount	integer	SANT 条目的个数。	1
SnatTableId	string	SNAT 列表的 ID。	stb-SnatTableIds****
FullNatTable	object	FULLNAT 列表的信息。
FullNatEntryCount	integer	FULLNAT 条目的个数。	1
FullNatTableId	string	FULLNAT 表的 ID。	fulltb-gw88z7hhlv43rmb26****
BillingConfig	object	账单配置信息。
InternetChargeType	string	NAT 网关实例的计费类型。取值： PayBySpec：按固定规格计费。 PayByLcu：按使用量计费。	PayBySpec
AutoPay	string	是否自动付费，当 InstanceChargeType 参数的值为 PrePaid 时，返回以下值： false：不开启自动付费，生成订单后需要到订单中心完成支付。 true：开启自动付费，自动支付订单。当 InstanceChargeType 参数的值为 PostPaid 时，返回值为空。	false
Spec	string	公网 NAT 网关实例的规格，且当 InternetChargeType 为 PayBySpec 时，返回以下值： Small：小型。 Middle：中型。 Large：大型。当 InternetChargeType 为 PayByLcu 时，返回值为空。	Small
InstanceChargeType	string	NAT 网关实例的付费模式，取值： PostPaid：按量付费。 PrePaid：包年包月。	PostPaid
PrivateInfo	object	NAT 网关实例的私网信息。
MaxBandwidth	integer	最大带宽值，单位为 Mbps。	5120
VswitchId	string	NAT 网关实例所属的交换机 ID。	vsw-bp1s2laxhdf9ayjbo***
PrivateIpAddress	string	私网 IP 地址。	192.168.XX.XX
IzNo	string	NAT 网关实例所属的可用区。	cn-qingdao-b
EniInstanceId	string	弹性网卡实例 ID。	eni-bp1cmgtoaka8vfyg****
DeletionProtectionInfo	object	删除保护信息。
Enabled	boolean	是否开启删除保护功能。 true：开启了删除保护功能。 false：未开启删除保护功能。	true
IpList	array<object>	公网 NAT 网关绑定的弹性公网 IP 列表。
	object	公网 NAT 网关绑定的弹性公网 IP 列表。
UsingStatus	string	公网 NAT 网关实例绑定的弹性公网 IP 的关联关系。 idle：弹性公网 IP 未关联 SNAT 条目或 DNAT 条目。 UsedBySnatTable：弹性公网 IP 已关联 SNAT 条目。 UsedByForwardTable：弹性公网 IP 已关联 DNAT 条目。	idle
IpAddress	string	弹性公网 IP 的地址。	116.33.XX.XX
AllocationId	string	弹性公网 IP 的实例 ID。	eip-bp13e9i2qst4g6jzi****
PrivateLinkEnabled	boolean	是否支持私网连接，取值： true：支持私网连接。 false：不支持私网连接。	true
PrivateLinkMode	string	私网连接服务转化模式，取值： FullNat：使用 FULLNAT 模式。 Geneve：使用 Geneve 模式。	FullNat
EnableSessionLog	boolean	是否开启会话日志，取值： true：已开启会话日志。 false：已关闭会话日志。	true
LogDelivery	object	会话日志配置信息。
LogDeliveryType	string	会话日志投递目的类型。取值： sls，阿里云日志服务 SLS。	sls
LogDestination	string	会话日志写入目的地址。	acs:log:cn-hangzhou:0000:project/nat_session_log_project/logstore/session_log_test
DeliveryStatus	string	会话日志写入状态。取值： Succsess：成功。 Failure：失败。	Failure
DeliverLogsErrorMessage	string	会话日志写入失败的错误信息。	LogStoreNotExist: logstore session_log_test does not exist
AccessMode	object	反向访问 VPC NAT 网关的访问模式。
ModeValue	string	访问模式取值： route：路由模式。 tunnel：隧道模式。	route
TunnelType	string	隧道模式类型： geneve: Geneve 类型。	geneve
AvailabilityMode	string

示例

正常返回示例

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"
  },
  "AccessMode": {
    "ModeValue": "route",
    "TunnelType": "geneve"
  },
  "AvailabilityMode": ""
}

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.

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

变更历史

更多信息，参考变更详情。