查询SNAT规则或DNAT规则可用的弹性IP列表v3
更新时间 2025-09-24 10:34:47
最近更新时间: 2025-09-24 10:34:47
接口功能介绍
查询SNAT规则或DNAT规则可用的弹性IP列表v3
接口约束
无
URI
GET /v3/nat/availableFip
路径参数 无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池ID。 | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | |
natOid | 是 | String | NAT网关ID | ||
type | 是 | String | 规则类型(SNAT-SNAT规则; DNAT-DNAT规则) | ||
pageNum | 否 | Integer | 页码,至少1,默认1 | ||
pageSize | 否 | Integer | 每页数量,最大100,默认10 |
请求参数
请求头header参数 无
请求体body参数 无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 状态码。可能值: - 800:请求成功。 - 900:请求失败。 | 800 | |
error | String | 错误码。 | ECPC_1000 | |
message | String | 提示信息。 | OK. | |
returnObj | Object | 返回数据对象 | returnObj | |
表 returnObj |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
total | Long | 总记录数 | ||
list | Array of Objects | 数据列表 | list | |
表 list |
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
fipOid | String | 弹性IP ID | ||
floatingIpAddress | String | 弹性IP地址 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{
"statusCode":800,
"message":"OK.",
"returnObj":{
"total":1,
"list":[{
"fipOid":"XXXXXXXXXXXXX",
"floatingIpAddress":"XXX.XXX.XXX.XXX"
}]
}
}
状态码
请参考 状态码
错误码
请参考 错误码