查询云主机的云硬盘列表
接口功能介绍
查询云主机的云硬盘列表。
接口约束
- 当前页面接口为旧版 API,未来根据实际使用情况可能退役,推荐使用新版本接口,新版本接口更加规范,覆盖场景更全。
URI
POST /v4/ecs/disk/list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以调用regionID查看最新的天翼云资源池列表。 | 81f7728662dd11ec810800155d307d5b | |
azName | 否 | String | 可用区名称,您可以调用获取资源池信息,查询结果中zoneList内返回存在可用区名称(即多可用区,本字段填写实际可用区名称),若查询结果中zoneList为空(即为单可用区,本字段填写default),多可用区资源池下,必须指定可用区。 | az1 | |
ID | 是 | String | 云主机ID | d82f0125-55ed-07d7-52a8-acaedbd201af | |
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 | |
dickID | String | 云硬盘ID,推荐使用diskID,该字段将在后续进行逐步下线处理 | 70a3768d-386e-416c-8abc-fc467e67432c | |
diskID | String | 云硬盘ID | 70a3768d-386e-416c-8abc-fc467e67432c | |
diskType | String | 云硬盘类型,取值范围: data:数据盘, 系统盘,默认值为data | 数据盘 | |
encrypted | Boolean | 云硬盘加密标志,取值范围:true:加密,false:不加密 | false | |
type | String | 表示云硬盘类型,取值范围:SATA:普通IO,SAS:高IO,SSD:超高IO,SSD-genric:通用型SSD,FAST-SSD:极速型SSD | SATA | |
diskSize | Integer | 云硬盘容量,单位GB | 10 |
请求示例
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"azName": "az1",
"pageNo": 1,
"pageSize": 5,
"ID": "d82f0125-55ed-07d7-52a8-acaedbd201af"
}
响应示例
{
"returnObj": {
"currentCount": 1,
"totalCount": 2,
"totalPage": 1,
"results": [
{
"diskSize": 40,
"diskMode": "VBD",
"encrypted": false,
"type": "SATA",
"dickID": "e28b885e-457f-4c3b-a562-4e0fb4db8e64",
"diskID": "e28b885e-457f-4c3b-a562-4e0fb4db8e64",
"diskType": "系统盘"
},
{
"diskSize": 5,
"diskMode": "VBD",
"encrypted": false,
"type": "SATA",
"dickID": "443f5a6c-c73b-4898-ad1c-5f101401cb1a",
"diskID": "443f5a6c-c73b-4898-ad1c-5f101401cb1a",
"diskType": "数据盘"
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
错误码 | 描述 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Ecs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
Ecs.RegionInfo.AccessFailed | 查询资源池失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.DataDamaged | 查询资源池信息不符预期,请重试。如果多次尝试失败,请提交工单 |
Ecs.Parameter.InvalidAzName | 资源池中不存在该azName,请确认azName是否有效 |
Ecs.Instance.NotFound | 未找到对应云主机,请确认云主机ID是否正确 |
Openapi.EcsCheck.UnknownError | 云主机检查失败,请重试。如果多次尝试失败,请提交工单 |
Openapi.EcsFormat.FormatError | 查询云主机信息格式错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.EcsWorkorder.AccessFailed | 查询云主机信息失败,请重试。如果多次尝试失败,请提交工单 |