接口介绍
基于资源ID查询云硬盘详情。
接口约束
1、支持的线上资源池：一类节点均支持；
URI
GET /v4/ebs/info
请求参数
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| resourceID | 是 | String | 资源ID，订单创建后的返回值。参考云硬盘开通表resources | 参考请求示例 |
| regionID | 否 | String | 如本地语境支持保存regionID，那么建议传递 | 参考请求示例 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 返回状态码(800为成功，900为失败) | 参考响应示例 | |
| message | 是 | String | 失败时的错误描述，一般为英文描述 | 参考响应示例 | |
| description | 是 | String | 失败时的错误描述，一般为中文描述 | 参考响应示例 | |
| returnObj | 是 | Object | 磁盘详情对象 | 参考响应示例 | 参考表returnObj |
| errorCode | 是 | String | 业务细分码，为product.module.code三段式码. 参考结果码 |
参考响应示例 |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| name | 是 | String | 磁盘名 | 参考响应示例 |
| resourceUUID | 是 | String | 资源UUID（磁盘ID） | 参考响应示例 |
| resourceID | 是 | String | 资源ID（计费资源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 | 绑定的云主机名，有挂载时才返回 | 参考响应示例 |
| instanceUUID | 是 | String | 绑定云主机resourceUUID，有挂载时才返回 | 参考响应示例 |
| instanceStatus | 是 | String | 云主机状态starting/restarting/stopping，具体参考云主机状态，有挂载时才返回 | 参考响应示例 |
| multiAttach | 是 | Boolean | 是否共享云硬盘 | 参考响应示例 |
| attachments | 是 | Array of Object | 挂载信息。如果是共享挂载云硬盘，有多项 | 参考响应示例 |
| projectID | 是 | String | 资源所属企业项目ID | 参考响应示例 |
| isEncrypt | 是 | Boolean | 是否加密盘 | 参考响应示例 |
| kmsUUID | 是 | String | 加密盘密钥UUID，是加密盘时才返回 | 参考响应示例 |
| onDemand | 是 | Boolean | 是否按需订购，按需时才返回该字段 | 参考响应示例 |
| cycleType | 是 | String | month/year，非按需时返回 | 参考响应示例 |
| cycleCount | 是 | Integer | 包周期数，非按需时返回 | 参考响应示例 |
| regionID | 是 | String | 资源池ID | 参考响应示例 |
| azName | 是 | String | 多可用区下的可用区名字 | 参考响应示例 |
表 attachments
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| instanceUUID | 是 | String | 绑定云主机实例UUID | 参考响应示例 |
| attachmentID | 是 | String | 挂载ID | 参考响应示例 |
| device | 是 | String | 挂载设备名，比如/dev/sda | 参考响应示例 |
请求示例
请求头header
无
请求体body
{
"resourceID": "aad675518147489086c2dc2719bfbef3",
"regionID": "81f7728662dd11ec810800155d307d5b"
}
响应示例
{
"returnObj": {
"projectID": "0",
"name": "newname1109",
"diskMode": "VBD",
"multiAttach": false,
"resourceID": "aad675518147489086c2dc2719bfbef3",
"regionID": "81f7728662dd11ec810800155d307d5b",
"diskType": "SATA",
"expireTime": 1683630844000,
"isEncrypt": false,
"cycleType": "month",
"diskSize": 30,
"isPackaged": false,
"azName": "az1",
"diskStatus": "available",
"resourceUUID": "16ea5633-92e2-4d06-8290-722bc4bf4638",
"createTime": 1667992444000,
"updateTime" 1667992444000,
"cycleCount": 6
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
错误码
请参考通用结果码。
