查詢彈性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
}]
}
}
狀態碼
請參考
錯誤碼
請參考
