NAT网关
NAT网关
文档指南
请输入
- 文档首页
NAT网关API参考私网NAT地址DescribeNatIps - 查询NAT IP地址
复制全文
下载 pdfDescribeNatIps - 查询NAT IP地址
文档反馈
问问助手调用 DescribeNatIps 接口，查询满足指定条件的中转IP。
使用说明
- 若传入多个请求参数，会按照传入的进行查询，返回符合所有条件的中转IP，没有符合条件的返回空值。
- 若请求参数非必选参数均未传入，会按照当前登录账号查询，返回当前账号下的所有中转IP。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：DescribeNatIps
要执行的操作，取值：DescribeNatIps。
Version string 必选 示例值：2020-04-01
API的版本，取值：2020-04-01。
NatIpName string 可选 示例值：nat_ip_1
中转IP的名称。
PageNumber integer 可选 示例值：1
列表的页码，默认值为1。
PageSize integer 可选 示例值：20
分页查询时每页的行数。取值范围：1～100。 默认值为20。
NatIpIds.N string[] 可选 示例值：vpcnatip-3a4b****
NAT IP地址的ID。
- 参数 - N：表示NAT IP地址ID的序号，单次调用数量上限100个ID。
- 多个ID之间请使用&分隔。
NatGatewayId string 必选 示例值：ngw-2feq5xhimd88w59gp686****
私网NAT网关的ID。
返回参数
PageNumber integer 示例值：1
当前分页的页码。
PageSize integer 示例值：20
当前分页的行数。
RequestId string 示例值：2021062415303301022514515207C4****
请求ID。
NatIps object[] 示例值：-
中转IP的详细信息。
NatIpId string 示例值：vpcnatip-gw8y7q3cpk3fggs87****
中转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 示例值：Creating
中转IP的状态。
- Creating：创建中。
- Available：可用。
- Deleting：删除中。
- Deleted：已删除。
UsingStatus string 示例值：Idle
使用状态。
- Idle：空闲。
- UsedBySnat：被SNAT规则占用。
- UsedByDnat：被DNAT规则占用。
- UsedByNat：被NAT占用。
TotalCount integer 示例值：2
符合条件的中转IP总数。
请求示例
GET /?Action=DescribeNatIps&Version=2020-04-01&NatGatewayId=ngw-2feq5xhimd88w59gp686**** HTTP/1.1
Host: natgateway.cn-beijing.volcengineapi.com
ServiceName: natgateway
Region: cn-beijing
返回示例
{
"ResponseMetadata": {
"RequestId": "2021062415303301022514515207C4****",
"Action": "DescribeNatIps",
"Version": "2020-04-01",
"Service": "natgateway",
"Region": "cn-beijing"
},
"Result": {
"RequestId": "2021062415303301022514515207C4****",
"TotalCount": 2,
"PageNumber": 1,
"PageSize": 20,
"NatIps": [
{
"NatIpId": "vpcnatip-gw8y7q3cpk3fggs87****",
"NatGatewayId": "ngw-2feq5xhimd88w59gp686****",
"NatIpName": "nat_ip_1",
"NatIpDescription": "natip-1",
"NatIp":"192.168.XX.34",
"IsDefault": true,
"UsingStatus":"Idle"
},
{
"NatIpId": "vpcnatip-gw8y7q3cpk3fg666****",
"NatGatewayId": "ngw-2feq5xhimd88w59gp686****",
"NatIpName": "nat_ip_2",
"NatIpDescription": "natip-2",
"NatIp":"192.168.XX.12",
"IsDefault": false,
"Status":"Available",
"UsingStatus":"UsedBySnat"
}
]
}
}
错误码
最近更新时间：2025.12.23 18:53:53
这个页面对您有帮助吗？
有用
有用
无用
无用