接口功能介绍
查询某可用区全部云硬盘详情。
接口约束
无
接口是否审批
否
URI
GET /v4/ebs/list-ebs
Content-Type
application/json
路径参数
无
Query参数
表query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | 是 | String | 资源池ID。 | 41f64827f25f468595ffa3a5deb5d15d |
| pageNo | 否 | Integer | 默认为1。 | 1 |
| pageSize | 否 | Integer | 默认为10，最大值为300。 | 10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败)。 | 800 | |
| message | String | 成功或失败时的描述，一般为英文描述。 | region info empty | |
| description | String | 成功或失败时的描述，一般为中文描述。 | 资源池信息为空。 | |
| returnObj | Object | 返回数据体。 | returnObj | |
| errorCode | String | 业务细分码，为product.module.code三段式码，请参考错误码。 | ebs.regionInfo.empty | |
| error | String | 业务细分码，为product.module.code三段式大驼峰码，请参考错误码。 | Ebs.RegionInfo.Empty |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| diskList | Array of Objects | 返回数据集合。 | list | |
| diskTotal | Integer | 总数。 | 2 | |
| currentCount | Integer | 当前页记录数目。 | 1 | |
| totalCount | Integer | 总记录数。 | 10 | |
| totalPage | Integer | 总页数。 | 1 |
表 list
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| diskName | String | 云硬盘名称。 | ebs-hw87 | |
| diskID | String | 云硬盘ID。 | 0ae97ef5-6ee2-44af-9d05-1a509b0a1be6 | |
| diskSize | Integer | 磁盘大小，单位为GB。 | 10 | |
| diskType | String | 磁盘规格类型，取值为： ●SATA：普通IO。 ●SAS：高IO。 ●SSD：超高IO。 ●FAST-SSD：极速型SSD。 ●XSSD-0、XSSD-1、XSSD-2：X系列云硬盘。 | SATA | |
| diskMode | String | 云硬盘磁盘模式，取值为： ●VBD（Virtual Block Device）：虚拟块存储设备。 ●ISCSI （Internet Small Computer System Interface）：小型计算机系统接口。 ●FCSAN（Fibre Channel SAN）：光纤通道协议的SAN网络。 | FCSAN | |
| diskStatus | String | 参考云硬盘使用状态 | available | |
| createTime | Long | 创建时刻，epoch时戳，精度为毫秒。 | 1678501018000 | |
| updateTime | Long | 更新时刻，epoch时戳，精度为毫秒。 | 1678501018000 | |
| expireTime | Long | 过期时刻，epoch时戳，精度为毫秒。 | 1678501018000 | |
| isSystemVolume | Boolean | 只有为系统盘时才返回该字段。 | true | |
| isPackaged | Boolean | 是否随云主机一起订购。 | true | |
| instanceName | String | 绑定的云主机名称，有挂载时才返回。 | ins-jwe8 | |
| instanceID | String | 绑定的云主机ID，有挂载时才返回。 | 0ae97ef5-6ee2-44af-9d05-1a509b0a1be6 | |
| instanceStatus | String | 云主机状态，参考云主机使用状态 | running | |
| multiAttach | Boolean | 是否是共享云硬盘。 | false | |
| attachments | Array of Objects | 挂载信息。如果是共享挂载云硬盘，则返回多项；无挂载时不返回该字段。 | attachment | |
| projectID | String | 云硬盘所属的企业项目ID。 | 0 | |
| isEncrypt | Boolean | 是否是加密盘。 | true | |
| kmsUUID | String | 加密盘密钥UUID，是加密盘时才返回。 | 0ae97ef5-6ee2-44af-9d05-1a509b0a1be6 | |
| regionID | String | 资源池ID。 | 81f7728662dd11ec810800155d307d5b | |
| azName | String | 多可用区下的可用区名字，非多可用区不返回该字段。 | az2 | |
| diskFreeze | String | 云硬盘是否已冻结。 | false | |
| provisionedIops | Integer | XSSD类型盘的预配置iops，未配置返回0，其他类型云硬盘不返回。 | 1 |
表 attachment
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| instanceID | String | 绑定的云主机ID。 | 24690060-c475-ed64-fd2c-7e96f9a1df37 | |
| attachmentID | String | 挂载ID。 | 24690060-c475-ed64-fd2c-7e96f9a1df37 | |
| device | String | 挂载的设备名，例如/dev/sda。 | /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
}状态码
请参考状态码
错误码
请参考错误码
