You need to enable JavaScript to run this app.
文档中心
NAT网关

NAT网关

复制全文
下载 pdf
NAT网关
DescribeNatGatewayAttributes - 查看指定NAT网关详情
复制全文
下载 pdf
DescribeNatGatewayAttributes - 查看指定NAT网关详情
调用 DescribeNatGatewayAttributes 接口,查看NAT网关详情。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:DescribeNatGatewayAttributes​
要执行的操作,取值:DescribeNatGatewayAttributes。​
​
Version string 必选 示例值:2020-04-01​
API的版本,取值:2020-04-01。​
​
NatGatewayId string 必选 示例值:ngw-0x57a0gevp****​
NAT网关的ID。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
SmartScheduleEnabled boolean 示例值:false​
是否开启智能调度。​
  • true:是。​
  • false:否。​
说明​
本功能暂仅支持完成企业认证的账号申请试用,如需试用,请联系客户经理。​
​
SmartScheduleRule string 示例值:BGP​
智能调度策略规则。​
  • ChinaMobile:中国移动。​
  • ChinaUnicom:中国联通。​
  • ChinaTelecom:中国电信。​
  • BGP:BGP多线。​
​
NatIpAddresses object[] 示例值:-​
私网NAT网关实例的中转IP列表。​
NatIpId string 示例值:vpcnatip-gw8y7q3cpk3fggs87****​
中转IP的ID。​
​
NatIpAddress string 示例值:192.168.XX.34​
中转IP的IP地址。​
​
​
DirectMode boolean 示例值:true​
是否为直通模式。​
  • true:是。​
  • false:否。​
​
NatGatewayId string 示例值:ngw-3tex2x1cwd4c6c0v****​
NAT网关的ID。​
​
NatGatewayName string 示例值:nat-01​
NAT网关的名称。​
​
Description string 示例值:This is a nat​
NAT网关的描述信息。​
​
RequestId string 示例值:2021062415303301022514515207C4****​
请求ID。​
​
Spec string 示例值:Medium​
NAT网关的规格。​
  • Small(默认):小型。​
  • Medium:中型。​
  • Large:大型。​
​
EipAddresses object[] 示例值:-​
NAT网关绑定公网IP的信息。​
AllocationId string 示例值:eip-rs59q8hqtaf****​
公网IP的ID。​
​
EipAddress string 示例值:121.XX.XX.52​
公网IP的地址。​
​
UsingStatus string 示例值:Idle​
公网IP的使用状态。​
  • Idle:未使用。​
  • UsedBySnat:被SNAT规则使用。​
  • UsedByDnat:被DNAT规则使用。​
  • UsedByNat:被SNAT/DNAT规则同时使用。​
​
​
VpcId string 示例值:vpc-7dk2hs5smt0bu****​
NAT网关所属私有网络的ID。​
​
SubnetId string 示例值:subnet-mj6v3t43k05s****​
NAT网关所属子网的ID。​
​
ProjectName string 示例值:Project_1​
NAT网关所属项目的名称。​
​
ZoneId string 示例值:cn-beijing-a​
NAT网关所属主可用区的ID。​
​
NetworkInterfaceId string 示例值:eni-2dffi32452fcv2****​
NAT网关占用的网卡ID。​
​
Tags object[] 示例值:-​
NAT网关的标签信息。​
Key string 示例值:k1​
标签键。​
​
Value string 示例值:v1​
标签值。​
​
​
BillingType integer 示例值:2​
NAT网关的计费方式。​
  • 1 :包年包月。​
  • 2:按量计费-按规格计费。​
  • 3:按量计费-按使用量计费。​
​
DeletedTime string 示例值:2021-12-21 18:26:27​
预期资源强制回收时间。​
  • 包年包月NAT网关,此参数有返回值。​
  • 按量计费NAT网关,仅欠费冻结时,此参数有返回值。​
​
OverdueTime string 示例值:2021-12-06 18:26:27​
资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值。​
​
ExpiredTime string 示例值:2021-05-07 23:59:59​
包年包月NAT网关到期时间。仅包年包月计费类型的NAT网关会返回此参数。​
​
UpdatedAt string 示例值:2021-12-06T18:26:27+08:00​
NAT网关的最后操作时间。​
​
CreationTime string 示例值:2021-11-30T16:59:27+08:00​
NAT网关的创建时间。​
​
LockReason string 示例值:financial​
NAT网关实例被锁定的原因。​
  • financial:因欠费被锁定。​
  • security:因安全原因被锁定。​
​
BusinessStatus string 示例值:Normal​
NAT网关是否被锁定。​
  • 空值:正常未被锁定。​
  • Normal:正常未被锁定。​
  • FinancialLocked:因欠费被锁定。​
​
Status string 示例值:Available​
NAT网关的状态。​
  • Available:可用。​
  • Creating:创建中。​
  • Pending:操作中。​
  • Deleting:删除中。​
​
NetworkType string 示例值:internet​
NAT网关类型。​
  • internet:公网NAT网关。​
  • intranet:私网NAT网关。​
​
SnatEntryIds string[] 示例值:snat-3fvhk47kf56****​
SNAT规则ID列表。​
​
DnatEntryIds string[] 示例值:dnat-342abc3bc3****​
DNAT规则ID列表。​
​
​
​
请求示例​
​
GET /?Action=DescribeNatGatewayAttributes&Version=2020-04-01&NatGatewayId=ngw-2fesmko5zhdz459gp67sc**** HTTP/1.1​
Host: natgateway.cn-beijing.volcengineapi.com​
ServiceName: natgateway​
Region: cn-beijing​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20251223184826030017116094AB30B8",​
"Action": "DescribeNatGatewayAttributes",​
"Version": "2020-04-01",​
"Service": "natgateway",​
"Region": "cn-beijing"​
},​
"Result": {​
"SmartScheduleEnabled": true,​
"SmartScheduleRule": "BGP",​
"NatIpAddresses": [],​
"DirectMode": true,​
"NatGatewayId": "ngw-3tex2x1cwd4c6c0v****",​
"NatGatewayName": "nat-01",​
"Description": "This is a nat",​
"RequestId": "2021062415303301022514515207C4****",​
"Spec": "Medium",​
"EipAddresses": [],​
"VpcId": "vpc-7dk2hs5smt0bu****",​
"SubnetId": "subnet-mj6v3t43k05s****",​
"ProjectName": "Project_1",​
"ZoneId": "cn-beijing-a",​
"NetworkInterfaceId": "eni-2dffi32452fcv2****",​
"Tags": [],​
"BillingType": 2,​
"DeletedTime": "2021-12-21 18:26:27",​
"OverdueTime": "2021-12-06 18:26:27",​
"ExpiredTime": "2021-05-07 23:59:59",​
"UpdatedAt": "2021-12-06T18:26:27+08:00",​
"CreationTime": "2021-11-30T16:59:27+08:00",​
"LockReason": "financial",​
"BusinessStatus": "Normal",​
"Status": "Available",​
"NetworkType": "internet",​
"SnatEntryIds": [​
"snat-3fvhk47kf56****"​
],​
"DnatEntryIds": [​
"dnat-342abc3bc3****"​
]​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
MissingParameter​
The request is missing a required parameter.​
该请求缺少必要参数。​
404​
InvalidNatGateway.NotFound​
The specified NAT gateway does not exist.​
指定的NAT网关不存在。​
500​
InternalError​
An internal error has occurred.​
发生内部错误。​
​
​
最近更新时间:2026.01.16 10:41:13
这个页面对您有帮助吗?
有用
有用
无用
无用