查詢彈性IP可綁定虛機列表v3
更新時間 2025-08-26 16:07:57
最近更新時間: 2025-08-26 16:07:57
分享文章
接口功能介紹
查詢彈性IP可綁定虛機列表v3
接口約束
無
URI
GET /v3/fip/describeDesktopForFip
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 資源池ID。 | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | |
| desktopOid | 否 | String | 桌面ID | ||
| desktopName | 否 | 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
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| desktopOid | String | 虛機ID | ||
| desktopName | String | 虛機名稱 | ||
| nickname | String | 虛機別名 | ||
| createDate | Object | 虛機創建時間 | createDate | |
| portList | Array of Objects | 虛機網卡 | portList |
表 portList
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| portOid | String | 網卡ID | ||
| portUuid | String | 網卡UUID | ||
| ipAddr | String | 網卡ip地址 | ||
| subnetName | String | 所屬子網名稱 | ||
| subnetCidr | String | 所屬子網網段 | ||
| portName | String | 網卡名稱 |
枚舉參數
無
請求示例
請求url
無
請求頭header
無
請求體body
無
響應示例
{
"statusCode":800,
"message":"OK.",
"returnObj":{
"total":1,
"list":[{
"vpcOid":"fooId",
"desktopOid":"D0025042501321534",
"desktopName":"0000ecfi-KQoXL3qgpc",
"nickname":"null,",
"createDate":"1745552277000,",
"portList":[{
"portOid":"port-flqrdu1mq3grx34c5ifxf",
"portUuid":"735d6f8c-1b19-430f-9c5f-9c90afce2cda",
"ipAddr":"172.16.0.220",
"subnetName":"vpc-172",
"subnetCidr":"172.16.0.0/24",
"portName":null
}]
}]
}
}
狀態碼
請參考
錯誤碼
請參考
