接口功能介绍
该接口提供查询云主机的云硬盘列表功能
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
注意事项：
分页查询：当前查询结果以分页形式进行展示，单次查询最多显示50条数据
接口约束
确保当前请求资源池下，该云主机存在
URI
POST /v4/ecs/volume/list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| instanceID | 是 | String | 云主机ID，您可以查看弹性云主机了解云主机的相关信息 获取： 查 查询云主机列表 创 创建一台按量付费或包年包月的云主机 创 批量创建按量付费或包年包月云主机 |
adc614e0-e838-d73f-0618-a6d51d09070a | |
| pageNo | 否 | Integer | 页码，取值范围：正整数（≥1），注：默认值为1 | 1 | |
| pageSize | 否 | Integer | 每页记录数目，取值范围：[1, 50]，注：默认值为10 | 10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| message | String | 失败时的错误描述，一般为英文描述 | SUCCESS | |
| description | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| currentCount | Integer | 当前页记录数目 | 1 | |
| totalCount | Integer | 总记录数 | 10 | |
| totalPage | Integer | 总页数 | 1 | |
| results | Array of Objects | 分页明细 | results |
表 results
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| diskMode | String | 云硬盘属性，取值范围： FCSAN（光纤通道协议的SAN网络）， ISCSI（小型计算机系统接口）， VBD（虚拟块存储设备） |
VBD | |
| diskID | String | 云硬盘ID | db09ec12-8e80-4514-8dbd-d1be5a6b5a80 | |
| diskType | String | 云硬盘类型，取值范围： 数据盘， 系统盘 |
系统盘 | |
| isEncrypt | Boolean | 云硬盘加密标志，取值范围： true（加密）， false（未加密） |
false | |
| diskDataType | String | 云硬盘类型，取值范围： SATA（普通IO）， SAS（高IO）， SSD（超高IO）， SSD-genric（通用型SSD）， FAST-SSD（极速型SSD） |
SATA | |
| diskSize | Integer | 云硬盘容量大小，单位GB | 20 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例：查询指定云主机下的云硬盘列表在华东1资源池查询1台云主机的云硬盘列表，设定查询每页数目为2，查看第1页云硬盘信息
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"pageNo": 1,
"pageSize": 2,
"instanceID": "c5a7966a-88e7-362b-6e11-c2d8fbfc07ca"
}
响应示例
{
"returnObj": {
"currentCount": 2,
"totalCount": 2,
"totalPage": 1,
"results": [{
"diskType": "系统盘",
"isEncrypt": false,
"diskSize": 40,
"diskMode": "VBD",
"diskID": "2f5c0520-e56d-488f-9628-c7770f1112d5",
"diskDataType": "SATA"
}, {
"diskType": "数据盘",
"isEncrypt": false,
"diskSize": 20,
"diskMode": "VBD",
"diskID": "fdb73b14-117a-489f-9f34-addbb0a450e8",
"diskDataType": "SATA"
}]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
