查询云主机的云硬盘列表
接口功能介绍
查询云主机的云硬盘列表。
接口约束
无
URI
POST /v4/ecs/volume/list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以调用regionID查看最新的天翼云资源池列表 | bb9fdb42056f11eda1610242ac110002 | |
instanceID | 是 | String | 云主机ID | c5a7966a-88e7-362b-6e11-c2d8fbfc07ca | |
pageNo | 否 | Integer | 页码,取值范围:大于等于1,默认值为1 | 1 | |
pageSize | 否 | Integer | 每页记录数目,取值范围:[1~50],默认值为10,单页最大记录不超过50 | 10 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | 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、ISCSI、VBD],默认值为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 |
请求示例
请求头header
无
请求体body
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"pageNo": 1,
"pageSize": 5,
"instanceID": "c5a7966a-88e7-362b-6e11-c2d8fbfc07ca"
}
响应示例
{
"returnObj": {
"currentCount": 1,
"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
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功 |
错误码
错误码 | 描述 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Ecs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
Ecs.RegionInfo.AccessFailed | 查询资源池失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.DataDamaged | 查询资源池信息不符预期,请重试。如果多次尝试失败,请提交工单 |
Ecs.Instance.NotFound | 未找到对应云主机,请确认云主机ID是否正确 |
Openapi.EcsCheck.UnknownError | 云主机检查失败,请重试。如果多次尝试失败,请提交工单 |
Openapi.EcsFormat.FormatError | 查询云主机信息格式错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.EcsWorkorder.AccessFailed | 查询云主机信息失败,请重试。如果多次尝试失败,请提交工单 |