接口功能介绍
查询中转IP
接口约束
已创建私网NAT实例
接口是否审批
否
URI
GET /v4/privatenat/list-ips
Content-Type
application/json
路径参数
无
Query参数
| Query参数 | 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| regionID | 是 | String | 区域id | 81f7728662dd11ec810800155d307d5b | |
| natGatewayID | 是 | String | 要查询的私网NAT的ID。 | ngw-bp1uewa15k4iy5770 | |
| address | 否 | String | 要搜索的地址。 | 192.168.1.2 |
请求头header参数
无
请求体body参数
无
响应参数
| 响应参数 | 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | ||
| message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success | ||
| description | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 | ||
| errorCode | String | statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS | SUCCESS | ||
| returnObj | Array of Objects | 返回结果 | returnObj |
| 表 returnObj | 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| address | String | 中转IP的地址 | 192.168.1.1 | ||
| status | String | 中转IP状态: running代表运行中, freeze代表已冻结, expired代表已到期 | running | ||
| isDefault | Boolean | 是否为默认中转地址 | true | ||
| snatCnt | Integer | 在使用此中转IP的snat数量 | 8 | ||
| dnarCnt | Integer | 在使用此中转IP的dnat数量 | 6 |
枚举参数
无
请求头header示例
无
请求url示例
GET /v4/privatenat/list-ips?regionID=81f7728662dd11ec810800155d307d5b&natGatewayID=natgw-bp1uewa15k4
请求体body示例
无
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "",
"returnObj": [
{
"address": "192.168.22.22",
"status": "running",
"isDefault": true,
"snatCnt": 6,
"dnatCnt": 6,
}
]
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功 |
错误码
请参考 错误码说明。
