查询云硬盘列表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"
}]
}
}
状态码
请参考 状态码
错误码
请参考 错误码
