查询弹性IP列表v3
更新时间 2025-08-26 16:07:55
最近更新时间: 2025-08-26 16:07:55
接口功能介绍
查询弹性IP列表v3
接口约束
无
URI
GET /v3/fip/describe
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池ID。 | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | |
floatingIpAddress | 否 | String | 弹性IP地址 | ||
desktopOid | 否 | String | 已绑定的桌面ID | ||
ipAddr | 否 | String | 已绑定的桌面的IP地址 | ||
bandName | 否 | String | 带宽名称 | ||
resourcePackName | 否 | String | 资源包名称 | ||
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 | ||
fipUuid | String | 弹性IP UUID | ||
floatingIpAddress | String | 弹性IP地址 | ||
bindObjType | String | 绑定状态和已绑定实例的对象类型,[0:未绑定,1:虚机,2:仅SNAT规则,3:仅DNAT规则,4:VIP,5:SNAT规则和DNAT规则,5:PORT,12:ELB,98:绑定中,99:解绑中] | ||
bandName | String | 带宽名称 | ||
bandWidth | Integer | 带宽,单位:MBps | ||
desktopName | String | 绑定弹性IP的对象名称 | ||
desktopOid | String | 绑定弹性IP的对象编码 | ||
ipAddr | String | 已绑定对象的IP地址 | ||
resourcePackOid | String | 资源包ID | ||
resourcePackName | String | 资源包名称 | ||
status | Integer | 弹性IP状态,[0:创建中,1:正常,2:已删除,3:DOWN,4:错误,5:删除中,6:冻结] |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{
"statusCode":800,
"message":"OK.",
"returnObj":{
"total":1,
"list":[{
"fipOid":"fip-xxitowt6ljhydytg4lim0",
"fipUuid":"f10ee930-605a-4b35-b197-5b3f19c0264f",
"floatingIpAddress":"10.33.153.188",
"bindObjType":"0",
"bandName":"bandwidth-vlme54p9k0:0",
"bandWidth":1,
"desktopName":"000000bf-53CU9sFN0P",
"desktopOid":"D0221011301037475",
"ipAddr":"192.168.0.101",
"resourcePackOid":"rsp-3uyckx0nxry4rp3j3482e",
"resourcePackName":"pkg-vb3j",
"status":1
}]
}
}
状态码
请参考 状态码
错误码
请参考 错误码