接口介绍
查询某可用区全部云硬盘详情。
接口约束
1、支持的线上资源池：一类节点均支持；
URI
GET /v4/ebs/list
请求参数
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 参考请求示例 |
| pageNo | 否 | Integer | 默认1 | 参考请求示例 |
| pageSize | 否 | Integer | 默认10 | 参考请求示例 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 返回状态码(800为成功，900为失败) | 参考响应示例 | |
| message | 是 | String | 失败时的错误描述，一般为英文描述 | 参考响应示例 | |
| description | 是 | String | 失败时的错误描述，一般为中文描述 | 参考响应示例 | |
| returnObj | 是 | Object | 参考表returnObj | 参考响应示例 | 参考表returnObj |
| errorCode | 是 | String | 业务细分码，为product.module.code三段式码. 参考结果码 |
参考响应示例 |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| list | 是 | Object Array | 参考表list | ||
| total | 是 | Integer | 总数 | 2 | |
| currentCount | 是 | Integer | 当前页记录数目 | 1 | |
| totalCount | 是 | Integer | 总记录数 | 10 | |
| totalPage | 是 | Integer | 总页数 | 1 |
表 list
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| name | 是 | String | 磁盘名 | 参考响应示例 |
| resourceID | 是 | String | 资源ID（计费资源ID） | 参考响应示例 |
| diskSize | 是 | Integer | 磁盘大小（GB） | 参考响应示例 |
| diskType | 是 | String | 磁盘规格类型 SATA/SAS/SSD-genric/SSD/FAST-SSD | 参考响应示例 |
| diskMode | 是 | String | 磁盘模式。VBD/ISCSI/FCSAN | 参考响应示例 |
| diskStatus | 是 | String | 云硬盘使用状态 deleting/creating/detaching，具体请参考云硬盘使用状态 | 参考响应示例 |
| createTime | 是 | Integer | 创建时刻，epoch时戳，精度毫秒 | 参考响应示例 |
| updateTime | 是 | Integer | 更新时刻，epoch时戳，精度毫秒 | 参考响应示例 |
| expireTime | 是 | Integer | 过期时刻，epoch时戳，精度毫秒 | 参考响应示例 |
| isSystemVolume | 是 | Boolean | 是否系统盘，只有为系统盘时才返回该字段 | 参考响应示例 |
| isPackaged | 是 | Boolean | 是否是云主机成套资源 | 参考响应示例 |
| instanceName | 是 | String | 绑定的云主机名，有挂载时才返回 | 参考响应示例 |
| instanceUUID | 是 | String | 绑定云主机resourceUUID，有挂载时才返回 | 参考响应示例 |
| instanceStatus | 是 | String | 云主机状态starting/restarting/stopping，具体参考云主机状态，有挂载时才返回 | 参考响应示例 |
| multiAttach | 是 | Boolean | 是否共享云硬盘 | 参考响应示例 |
| attachments | 是 | Object of Array | 挂载信息。如果是共享挂载云硬盘，有多项 | 参考响应示例 |
| projectID | 是 | String | 资源所属企业项目ID | 参考响应示例 |
| isEncrypt | 是 | Boolean | 是否加密盘 | 参考响应示例 |
| kmsUUID | 是 | String | 加密盘密钥UUID，是加密盘时才返回 | 参考响应示例 |
| regionID | 是 | String | 资源池ID | 参考响应示例 |
| azName | 是 | String | 多可用区下的可用区名字 | 参考响应示例 |
表 attachments
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| instanceUUID | 是 | String | 绑定云主机实例UUID | 参考响应示例 |
| attachmentID | 是 | String | 挂载ID | 参考响应示例 |
| device | 是 | String | 挂载设备名，比如/dev/sda | 参考响应示例 |
请求示例
请求头header
无
请求体body
{
"regionID": "41f64827f25f468595ffa3a5deb5d15d",
"pageNo": 1,
"pageSize": 20
}
响应示例
{
"returnObj": {
"total": 2,
"currentCount": 2,
"totalCount": 2,
"totalPage": 2,
"list": [
{
"instanceStatus": "running",
"projectID": "0",
"instanceUUID": "70a713e4-7738-d346-be6b-953812abaa20",
"name": "xx-vm-1-volume-001",
"diskMode": "VBD",
"multiAttach": false,
"resourceID": "1cb57798b70c47d9a69e9a00ad762446",
"regionID": "81f7728662dd11ec810800155d307d5b",
"diskType": "SATA",
"expireTime": null,
"isEncrypt": false,
"diskSize": 5,
"isPackaged": true,
"azName": "az1",
"diskStatus": "in-use",
"instanceName": "xx-vm-1",
"createTime": 1666075102000,
"attachments": [
{
"device": "/dev/vdb",
"attachmentID": "798f678a-a157-4863-8c4c-205da1738380",
"instanceUUID": "70a713e4-7738-d346-be6b-953812abaa20"
}
]
},
{
"instanceStatus": "running",
"projectID": "0",
"instanceUUID": "70a713e4-7738-d346-be6b-953812abaa20",
"name": "xx-vm-1-volume_000",
"diskMode": "VBD",
"multiAttach": false,
"resourceID": "43a6e3b92ab34bc39c8aaeaa7406cbd2",
"regionID": "81f7728662dd11ec810800155d307d5b",
"diskType": "SATA",
"expireTime": null,
"isEncrypt": false,
"diskSize": 40,
"isPackaged": true,
"azName": "az1",
"diskStatus": "in-use",
"isSystemVolume": true,
"instanceName": "xx-vm-1",
"createTime": 1666075079000,
"attachments": [
{
"device": "/dev/vda",
"attachmentID": "e6dcc769-4bf7-4bc0-be25-b2a87a55c467",
"instanceUUID": "70a713e4-7738-d346-be6b-953812abaa20"
}
]
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
错误码
请参考通用结果码。
