查詢云硬盤列表v3
更新時間 2025-08-26 16:07:51
最近更新時間: 2025-08-26 16:07:51
分享文章
接口功能介紹
- 云硬盤功能請聯系客戶經理開通。
接口約束
無
URI
GET /v3/cloudVolume/describe
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 資源池ID。 | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | |
| desktopOid | 否 | String | 云電腦ID，通過指定云電腦ID和云硬盤狀態以獲取該云電腦可掛載的云硬盤列表 | ||
| diskType | 否 | String | 云硬盤類型（uhio-超高IO;hio-高IO;cio-普通IO） | ||
| forSysDisk | 否 | Boolean | 是否查詢屬性為系統盤的云硬盤。true則返回屬性為系統盤的云硬盤，false則返回屬性為數據盤的云硬盤，缺省則返回屬性為系統盤和數據盤的云硬盤 | ||
| status | 否 | String | 云硬盤狀態（CREATING-創建中;AVAILABLE-可用;INUSE-使用中;MOUNTING-掛載中;UNMOUNTING-卸載中;EXTENDING-擴容中;CREATE_SNAPSHOT_ING-創建快照中;REVERTING-回滾中;DELETING-刪除中） | ||
| 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
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| volumeOid | String | 云硬盤ID | XXXXXXXXXXXXX | |
| volumeName | String | 云硬盤名稱 | ||
| volumeSize | Integer | 云硬盤大小（單位：GB） | ||
| diskType | String | 云硬盤類型（uhio-超高IO;hio-高IO;cio-普通IO） | ||
| forSysDisk | Boolean | 屬性是否為系統盤，true表示為系統盤屬性，false表示為數據盤屬性 | ||
| encryption | Boolean | 是否加密，true表示為加密，false表示為不加密 | ||
| status | String | 云硬盤狀態（CREATING-創建中;AVAILABLE-可用;INUSE-使用中;MOUNTING-掛載中;UNMOUNTING-卸載中;EXTENDING-擴容中;CREATE_SNAPSHOT_ING-創建快照中;REVERTING-回滾中;DELETING-刪除中） | ||
| desktopOid | String | 云電腦ID | ||
| createTime | String | 創建時間。以ISO 8601為標準，并使用UTC+0時間，格式為yyyy-MM-ddTHH:mm:ssZ。 |
枚舉參數
無
請求示例
請求url
無
請求頭header
無
請求體body
無
響應示例
{
"statusCode":800,
"message":"OK.",
"returnObj":{
"total":1,
"list":[{
"volumeOid":"XXXXXXXXXXXXX",
"volumeName":"cv-test",
"volumeSize":40,
"diskType":"uhio",
"forSysDisk":false,
"encryption":false,
"status":"AVAILABLE",
"desktopOid":"xxxxxxxxxxxxxxxx",
"createTime":"2099-09-09T00:00:00Z"
}]
}
}
狀態碼
請參考
錯誤碼
請參考
