接口介绍
查询某可用区全部云硬盘详情。
接口约束
1、支持的线上资源池:一类节点均支持;
URI
GET /v4/ebs/list-ebs
Query参数
表query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID | 参考请求示例 | |
pageNo | 否 | Integer | 默认1 | 参考请求示例 | |
pageSize | 否 | Integer | 默认10 | 参考请求示例 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回状态码(800为成功,900为失败) | 参考响应示例 | |
message | 是 | String | 失败时的错误描述,一般为英文描述 | 参考响应示例 | |
description | 是 | String | 失败时的错误描述,一般为中文描述 | 参考响应示例 | |
returnObj | 是 | Object | 参考表returnObj | 参考响应示例 | 参考表returnObj |
errorCode | 是 | String | 业务细分码,为product.module.code三段式码. 参考结果码 |
参考响应示例 |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
diskList | 是 | Object Array | 参考表list | ||
diskTotal | 是 | Integer | 总数 | 2 | |
currentCount | 是 | Integer | 当前页记录数目 | 1 | |
totalCount | 是 | Integer | 总记录数 | 10 | |
totalPage | 是 | Integer | 总页数 | 1 |
表 list
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
diskName | 是 | String | 磁盘名 | 参考响应示例 | |
diskID | 是 | String | 磁盘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 | 绑定的云主机名,有挂载时才返回 | 参考响应示例 | |
instanceID | 是 | String | 绑定云主机resourceUUID,有挂载时才返回 | 参考响应示例 | |
instanceStatus | 是 | String | 云主机状态starting/restarting/stopping,具体参考云主机状态,有挂载时才返回 | 参考响应示例 | |
multiAttach | 是 | Boolean | 是否共享云硬盘 | 参考响应示例 | |
attachments | 是 | ObjectArray | 挂载信息。如果是共享挂载云硬盘,有多项,无挂载时不返回该字段 | 参考响应示例 | 参考表attachment |
projectID | 是 | String | 资源所属企业项目ID | 参考响应示例 | |
isEncrypt | 是 | Boolean | 是否加密盘 | 参考响应示例 | |
kmsUUID | 是 | String | 加密盘密钥UUID,是加密盘时才返回 | 参考响应示例 | |
regionID | 是 | String | 资源池ID | 参考响应示例 | |
azName | 是 | String | 多可用区下的可用区名字,非多可用区不返回该字段 | 参考响应示例 |
表 attachment
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
instanceID | 是 | String | 绑定云主机实例UUID | 参考响应示例 | |
attachmentID | 是 | String | 挂载ID | 参考响应示例 | |
device | 是 | String | 挂载设备名,比如/dev/sda | 参考响应示例 |
请求示例
请求头header示例
{
}
请求url示例
.../v4/ebs/list-ebs?regionID=81f7728662dd11ec810800155d307d5b&pageNo=1&pageSize=20
请求体body示例
无
响应示例
{
"returnObj": {
"diskList": [
{
"diskName": "ebs-newspec-test0211v7",
"isPackaged": false,
"diskMode": "VBD",
"multiAttach": false,
"projectID": "0",
"regionID": "81f7728662dd11ec810800155d307d5b",
"updateTime": 1676081845000,
"diskType": "SATA",
"expireTime": 1678501018000,
"isEncrypt": false,
"diskSize": 10,
"azName": "az2",
"diskStatus": "available",
"createTime": 1676081790000,
"diskID": "0ae97ef5-6ee2-44af-9d05-1a509b0a1be6"
},
{
"diskName": "ebs-newspec-test0211v6",
"isPackaged": false,
"diskMode": "VBD",
"multiAttach": false,
"projectID": "0",
"regionID": "81f7728662dd11ec810800155d307d5b",
"updateTime": 1676081593000,
"diskType": "SATA",
"expireTime": 1678500768000,
"isEncrypt": false,
"diskSize": 10,
"azName": "az2",
"diskStatus": "available",
"createTime": 1676081534000,
"diskID": "db9d4a8d-32ba-40d5-b367-3427e42062dd"
},
],
"diskTotal": 2,
"currentCount": 2,
"totalCount": 2,
"totalPage": 2
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功 |
错误码
请参考通用结果码。