DescribeNatIpAttributes--NAT网关-火山引擎

文档中心

立即注册

导航

DescribeNatIpAttributes

最近更新时间：2024.12.05 18:57:58首次发布时间：2023.11.07 08:15:17

调用 DescribeNatIpAttributes 接口，查看指定的中转IP。

说明

私网NAT网关正在邀测中，如需试用，请联系客户经理。

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	DescribeNatIpAttributes	要执行的操作，取值：DescribeNatIpAttributes。
Version	String	是	2020-04-01	API的版本信息，当前版本为：2020-04-01。
NatIpId	String	是	vpcnatip-gw8y7q3cpk3fggs87****	中转IP的ID。

返回数据

参数名称	类型	示例值	描述
RequestId	String	2021062415303301022514515207C4****	请求ID。
NatIpId	String	vpcnatip-gw8y7q3cpk3fggs87****	中转IP的ID。
NatGatewayId	String	ngw-1sm2t10buei****	私网NAT网关ID
NatIpName	String	nat_ip_1	中转IP的名称。
NatIpDescription	String	natip-1	中转IP的描述。
NatIp	String	192.168.XX.34	中转IP的IP地址。
IsDefault	bool	true	是否为默认中转IP。 true：是。 false：否。
Status	String	Available	中转IP的状态。 Creating：创建中。 Available：可用。 Deleting：删除中。 Deleted：已删除。
UsingStatus	string	Idle	中转IP的使用状态。 Idle：未使用。 UsedBySnat：被SNAT规则使用。 UsedByDnat：被DNAT规则使用。 UsedByNat：被SNAT/DNAT规则同时使用。

请求示例

GET /?Action=DescribeNatIpAttributes&Version=2020-04-01&NatIpId=vpcnatip-gw8y7q3cpk3fggs87**** HTTP/1.1
Host: open.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":"UsedBySnat"
    }
}

错误码

公共错误码，请参见公共错误码。

HttpCode	错误码	错误信息	描述
404	InvalidNatIp.NotFound	The specified nat ip does not exist.	指定的NAT IP不存在。