查詢計算增強型云電腦列表v3
更新時間 2025-08-26 16:07:43
最近更新時間: 2025-08-26 16:07:43
分享文章
接口功能介紹
- 計算增強型云電腦功能請聯系客戶經理開通。
接口約束
無
URI
GET /v3/ecs/describe
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 資源池ID。 | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | |
| desktopOid | 否 | String | 云電腦ID | ||
| desktopNickName | 否 | String | 云電腦別名 | ||
| vpcOid | 否 | String | vpcId | ||
| subnetOidList | 否 | String | VPC子網ID。取值由VPC子網ID組成一個JSON數組,最多支持20個ID,ID之間用半角逗號(,)隔開。 | ||
| status | 否 | String | 運行狀態(Creating-創建中;Stopped-已關機;Starting-啟動中;Running-運行中;Rebooting-重啟中;Rebuilding-重裝中;Stopping-關閉中;Deleting-刪除中;Unhealthy-異常;RollingBack-回滾中;Resizing-變更中;Evacuating-遷移中;Rescuing-救援中;BackingUp-備份中;DeletingBackup-刪除備份中;Regaining-恢復中;Hibernating-休眠中;Hibernated-已休眠;WakingUp-喚醒中) | ||
| 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 | XXXXXXXXXXXXX6925 | |
| desktopName | String | 云電腦名稱 | ||
| nickname | String | 云電腦別名 | ||
| osType | String | 操作系統類型(Windows;Linux) | ||
| status | String | 運行狀態(Creating-創建中;Stopped-已關機;Starting-啟動中;Running-運行中;Rebooting-重啟中;Rebuilding-重裝中;Stopping-關閉中;Deleting-刪除中;Deleted-已刪除;Unhealthy-異常;RollingBack-回滾中;Resizing-變更中;Evacuating-遷移中;Rescuing-救援中;BackingUp-備份中;DeletingBackup-刪除備份中;Regaining-恢復中;Hibernating-休眠中;Hibernated-已休眠;WakingUp-喚醒中) | ||
| flavorType | String | 規格類型。可能值:[Common-通用型, Gpu-GPU型, Hpn-高性能網絡型, Kp-鯤鵬, Hg-海光]。 | ||
| cpuArch | String | CPU架構。僅對XC型規格有意義。可能值:[arm, x86]。 | ||
| processorType | String | 處理器類型。僅對XC型規格有意義。可能值: - kp:鯤鵬。 - hg:海光。 |
kp | |
| cpu | Integer | CPU個數 | ||
| memory | Integer | 內存大小(單位:GB) | ||
| gpuMemory | Integer | 顯存大小(單位:GB)。僅對GPU規格云電腦有意義。 | ||
| sysDisk | Object | 系統盤 | sysDisk | |
| dataDisks | Array of Objects | 數據盤 | dataDisks | |
| imageOid | String | 鏡像ID | ||
| templateOid | String | 規格模板ID | ||
| osName | String | 操作系統名稱 | ||
| org | Object | 歸屬部門 | org | |
| vpcOid | String | VPC ID | ||
| vpcName | String | VPC名稱 | ||
| subnets | Array of Objects | 所在子網集合 | subnets | |
| eipAddresses | Array of Objects | 彈性ip列表 | eipAddresses | |
| pubUserOid | String | 分配用戶ID(當且僅當用戶與云電腦綁定成功時返回) | ||
| userName | String | 分配用戶名稱(當且僅當用戶與云電腦綁定成功時返回) | ||
| chargeType | String | 計費方式。枚舉值范圍:[PrePaid-包年包月, ResourcePack-資源包] | ||
| createTime | String | 創建時間。以ISO 8601為標準,并使用UTC+0時間,格式為yyyy-MM-ddTHH:mm:ssZ。 | ||
| expireTime | String | 到期時間。以ISO 8601為標準,并使用UTC+0時間,格式為yyyy-MM-ddTHH:mm:ssZ。 |
表 sysDisk
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| diskOid | String | 磁盤ID | ||
| diskType | String | 磁盤類型(hio-高IO(high IO);uhio-超高IO(ultra-high IO) | ||
| diskSize | Integer | 磁盤大小。單位:GB | ||
| availableBytes | String | 磁盤剩余可用字節數。單位:B。注意:上報情況存在延遲,可能為空。 | 66666666666 | |
| diskUuid | String | 磁盤UUID |
表 dataDisks
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| diskOid | String | 磁盤ID | ||
| diskType | String | 磁盤類型(hio-高IO(high IO);uhio-超高IO(ultra-high IO) | ||
| diskSize | Integer | 磁盤大小。單位:GB | ||
| availableBytes | String | 磁盤剩余可用字節數。單位:B。注意:上報情況存在延遲,可能為空。 | 66666666666 | |
| diskUuid | String | 磁盤UUID |
表 org
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| orgOid | String | 部門ID | ||
| completeOrgName | String | 完整部門名稱。由從根部門到當前部門的名稱,以半角斜線號(/)為分隔符拼接而成。 |
表 subnets
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| subnetOid | String | 子網ID | ||
| privateIpAddresses | Array of Objects | 私有IP地址集合 | privateIpAddresses |
表 privateIpAddresses
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| address | String | IP地址 | ||
| portOid | String | 網卡ID | ||
| isDefault | Boolean | 是否為默認網卡,true表示是,false表示否 |
表 eipAddresses
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| eipOid | String | 彈性IP ID | ||
| ipAddress | String | IP地址 | ||
| privateIpAddress | String | 私有IP地址 |
枚舉參數
無
請求示例
請求url
無
請求頭header
無
請求體body
無
響應示例
{
"statusCode":800,
"message":"OK.",
"returnObj":{
"total":1,
"list":[{
"desktopOid":"XXXXXXXXXXXXX6925",
"desktopName":"desktopName",
"nickname":"nickname",
"osType":"Windows",
"status":"Running",
"flavorType":"Common",
"cpu":1,
"memory":2,
"gpuMemory":2,
"org":{
"orgOid":"fooId",
"completeOrgName":"fooRootName/fooName"
},
"vpcOid":"vpc-xxx",
"vpcName":"fooName",
"subnets":[{
"subnetOid":"sn-xxx",
"privateIpAddresses":[{
"address":"192.168.1.99",
"portOid":"port-xxx",
"isDefault":true
}]
}],
"eipAddresses":[{
"eipOid":"XXX",
"ipAddress":"X.X.X.X",
"privateIpAddress":"X.X.X.X"
}],
"sysDisk":{
"diskOid":"vol-xxx",
"diskType":"hio",
"diskSize":80,
"availableBytes":"66666666666"
},
"dataDisks":[{
"diskOid":"vol-yyy",
"diskType":"hio",
"diskSize":10,
"availableBytes":"6666666666"
}],
"imageOid":"mi-xxx",
"templateOid":"xxx",
"osName":"Windows 2016 Standard 64位 中文版",
"pubUserOid":"upg-xxx",
"userName":"fooName",
"chargeType":"ResourcePack",
"createTime":"2099-09-09T00:00:00Z",
"expireTime":"2099-09-09T00:00:00Z"
}]
}
}
狀態碼
請參考
錯誤碼
請參考