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

NAT网关

复制全文
下载 pdf
私网NAT地址
DescribeNatIpAttributes - 查询NAT IP地址详情
复制全文
下载 pdf
DescribeNatIpAttributes - 查询NAT IP地址详情
调用 DescribeNatIpAttributes 接口,查看指定的中转IP。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:DescribeNatIpAttributes​
要执行的操作,取值:DescribeNatIpAttributes。​
​
Version string 必选 示例值:2020-04-01​
API的版本,取值:2020-04-01。​
​
NatIpId string 必选 示例值:vpcnatip-gw8y7q3cpk3fggs87****​
中转IP的ID。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
UsingStatus string 示例值:Idle​
中转IP的使用状态。​
  • Idle:未使用。​
  • UsedBySnat:被SNAT规则使用。​
  • UsedByDnat:被DNAT规则使用。​
  • UsedByNat:被SNAT/DNAT规则同时使用。​
​
RequestId string 示例值:2021062415303301022514515207C4****​
请求ID。​
​
NatIpId string 示例值:vpcnatip-gw8y7q3cpk3fggs8****​
中转IP的ID。​
​
NatGatewayId string 示例值:ngw-2feq5xhimd88w59gp686****​
私网NAT网关ID​
​
NatIpName string 示例值:nat_ip_1​
中转IP的名称。​
​
NatIpDescription string 示例值:natip-1​
中转IP的描述。​
​
NatIp string 示例值:192.168.XX.34​
中转IP的IP地址。​
​
IsDefault boolean 示例值:true​
是否为默认中转IP。​
  • true:是。​
  • false:否。​
​
Status string 示例值:Avaliable​
中转IP的状态。​
  • Creating:创建中。​
  • Available:可用。​
  • Deleting:删除中。​
  • Deleted:已删除。​
​
​
​
请求示例​
​
GET /?Action=DescribeNatIpAttributes&Version=2020-04-01&NatIpId=vpcnatip-gw8y7q3cpk3fggs87**** HTTP/1.1​
Host: natgateway.cn-beijing.volcengineapi.com​
ServiceName: natgateway​
Region: cn-beijing​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "2021062415303301022514515207C4****",​
"Action": "DescribeNatIpAttributes",​
"Version": "2020-04-01",​
"Service": "natgateway",​
"Region": "cn-beijing"​
},​
"Result":{​
"RequestId": "2021062415303301022514515207C4****",​
"NatIpId": "vpcnatip-gw8y7q3cpk3fggs87****",​
"NatGatewayId": "ngw-2feq5xhimd88w59gp686****",​
"NatIpName": "nat_ip_1",​
"NatIpDescription": "natip-1",​
"NatIp":"192.168.XX.34",​
"IsDefault": true,​
"Status":"Available",​
"UsingStatus":"Idle"​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
MissingParameter​
The request is missing a required parameter.​
该请求缺少必要参数。​
404​
InvalidNatIp.NotFound​
The specified nat ip does not exist.​
指定的NAT IP不存在。​
500​
InternalError​
An internal error has occurred.​
发生内部错误。​
​
​
最近更新时间:2025.12.23 18:53:53
这个页面对您有帮助吗?
有用
有用
无用
无用