查询用云硬盘列表
更新时间 2026-05-22 16:14:24
最近更新时间: 2026-05-22 16:14:24
接口功能介绍
查看用户所在集群的云硬盘列表
接口约束
确定正确的nodeCode，可通过查看区域集群编码列表接口获取。
URI
GET /v3/disk/describeCloudDisks
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| nodeCode | 是 | String | 边缘池id，可通过查看区域集群编码列表接口获取。 | cn-guangzhou3 | |
| instanceType | 否 | String | 挂载的实例类型，可选值为：EVM 。 | EVM | |
| name | 否 | String | 硬盘名称(customName)或绑定实例名称(instanceName)。 | evm-opb0 | |
| diskInstanceName | 否 | String | 云盘实例名称。 | cd-xxxx | |
| page | 否 | Integer | 当前页数，默认值为1。 | 1 | |
| perPageNum | 否 | Integer | 每页显示的记录条数，默认值为10。 | 10 | |
| state | 否 | String | 硬盘状态, 可选值为：ACTIVE(正常)，RELEASED(已释放)，DELETED(已删除)，DELETING(删除中)，MOUNTING(挂载中)，UNMOUNTING(卸载中)，AVAILABLE(可用)，ALLSTATE(所有)，默认ACTIVE。 | ACTIVE | |
| ioType | 否 | String | 磁盘IO类型，可选值为：NORMAL(高IO)，HIGH(通用型SSD)， ULTRA(超高IO) ，ULTRAFAST(极速IO)，ALL_IO_TYPE(所有类型)，默认为NORMAL。 | NORMAL |
请求参数
请求头header参数 无
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。 | 200 | |
| message | String | 状态描述。 | Success | |
| returnObj | Array of Objects | 返回数据。 | returnObj | |
| error | String | 错误码，执行成功时，不返回该字段。 | ECX_0001 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| totalPage | Integer | 总页数。 | 1 | |
| total | Integer | 记录总个数。 | 6 | |
| page | Integer | 当前页数。 | 1 | |
| perPageNum | Integer | 每页显示的记录条数。 | 10 | |
| diskInfos | Array of Objects | 磁盘信息列表。 | diskInfos |
表 diskInfos
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| id | Integer | 硬盘ID。 | 1583 | |
| customName | String | 用户自定义硬盘名。 | cd-abc* | |
| isSystemDisk | Boolean | 是否系统盘。 | false | |
| diskSize | Integer | 硬盘容量大小，单位为G。 | 10 | |
| state | String | 硬盘状态。 正常 ACTIVE = 0; 已释放 RELEASED = 1; 已删除 DELETED = 2; 删除中 DELETING = 3; 挂载中MOUNTING = 4; 卸载中 UNMOUNTING= 5; 可用 AVAILABLE = 6; 所有 ALLSTATE = -1; | ACTIVE | |
| instanceType | String | 挂载的实例类型。 未知 UNKNOWN = 0; EVM = 3; | EVM | |
| instanceId | Integer | 挂载的实例ID。 | 150 | |
| instanceName | Array of Strings | 挂载的实例名称。 | * | |
| vmName | Array of Strings | 挂载的虚机名称。 | * | |
| diskIOType | String | 硬盘IO类型。 NORMAL(高IO)，HIGH(通用型SSD)， ULTRA(超高IO) ，ULTRAFAST(极速IO)，默查所有类型 ALL_IO_TYPE = -1; | HIGH | |
| createTime | String | 创建时间。 | 142334534 | |
| modifyTime | String | 修改时间。 | 142334534 | |
| diskInstanceName | String | 硬盘实例id。 | cd-lskdjfl** | |
| priceType | Integer | 计费类型。 TRAFFIC_BILLING: 按流量计费， ANNUAL_OR_MONTHLY: 包年包月， BANDWIDTH_FACTOR: 带宽折算， PAY_FOR_USE: 按需付费， PRICE_TYPE_UNDEFINED: 未定义。 | 1 | |
| subnetIp | String | evm 内网ip。 | 190.14.2.212 | |
| address | Array of Strings | 外网ip。 | * | |
| bus | String | 磁盘驱动类型。 支持virtio和SCSI，支持在线挂载/卸载。 | SCSI |
枚举参数
无
请求示例
请求url
GET https://{host}/v3/disk/describeCloudDisks?nodeCode=yn-xxx-1&instanceType=EVM&instanceName=evm-xxx&diskInstanceName=cd-xxx&page=1&perPageNum=10
请求头header
无
请求体body
无
响应示例
{
"statusCode": 200,
"message": "Success",
"returnObj": {
"totalPage": 1,
"total": 1,
"page": 1,
"perPageNum": 10,
"diskInfos": [
{
"instanceId": 0,
"instanceName": [
"evm-xxx"
],
"customName": "disk-g5tg",
"diskInstanceName": "cd-xxx",
"subnetIp": "",
"vmName": [
"evm-xxx"
],
"createTime": "1669007270",
"id": 1488,
"diskIOType": "NORMAL",
"state": "ACTIVE",
"diskSize": 20,
"modifyTime": "1669007270",
"bus": "SCSI",
"address": [],
"isSystemDisk": true,
"instanceType": "EVM",
"priceType": 5
}
]
}
}
状态码
请参考 状态码
错误码
请参考 错误码
