接口功能介绍
根据卷的id查询卷的详情
接口约束
- 当前页面接口为旧版 API，未来根据实际使用情况可能退役，推荐使用新版本接口，新版本接口更加规范，覆盖场景更全。
URI
GET /v4/ecs/volume_show
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| resourceID | 是 | String | 云硬盘资源ID | 4abf5a9e-271c-4b15-bdee-c4187fbe4531 | |
| regionID | 是 | String | 资源池ID，您可以调用资源池可用区查询查看最新的天翼云资源池列表 | 81f7728662dd11ec810800155d307d5b |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为处理中或失败) | 800 | |
| message | String | 失败时的错误描述，一般为英文描述 | Param is null | |
| description | String | 失败时的错误描述，一般为中文描述 | 请求为空 | |
| returnObj | Object | 返回参数 | returnObj | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | Ebs.RegionInfo.AccessFailed |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| name | String | 云硬盘名称 | ghy4-volume_000 | |
| resourceID | String | 云硬盘资源ID（计费资源ID） | 353b40956a3040c0b50489b5cb3fe1a6 | |
| diskSize | Integer | 磁盘大小，单位为GB | 20 | |
| diskType | String | 云硬盘类型，取值范围： SATA：普通IO SAS：高IO SSD：超高IO SSD-genric：通用型SSD FAST-SSD：极速型SSD |
SSD | |
| diskMode | String | 云硬盘属性，取值范围: [FCSAN、ISCSI、VBD]，默认值为VBD | FCSAN | |
| diskStatus | String | 云硬盘使用状态 | in-use | |
| createTime | Integer | 创建时刻，epoch时戳，精度毫秒 | 1665982704000 | |
| updateTime | Integer | 更新时刻，epoch时戳，精度毫秒 | 1665982704000 | |
| expireTime | Integer | 过期时刻，epoch时戳，精度毫秒 | 1665982704000 | |
| isSystemVolume | Boolean | 是否系统盘，只有为系统盘时才返回该字段 | ||
| isPackaged | Boolean | 是否是云主机成套资源 | false | |
| instanceName | String | 绑定的云主机名，有挂载时才返回 | test-server | |
| instanceUUID | String | 绑定云主机resourceUUID，有挂载时才返回 | b6e2966d-7b1c-385e-abe4-d940caa273b7 | |
| instanceStatus | String | 云主机状态，有挂载时才返回，取值范围： backingup: 备份中， creating: 创建中， expired: 已到期， freezing: 冻结中， rebuild: 重装， restarting: 重启中， running: 运行中， starting: 开机中， stopped: 已关机， stopping: 关机中 |
running | |
| multiAttach | Boolean | 是否共享云硬盘 | false | |
| attachments | Array of Objects | 挂载信息。如果是共享挂载云硬盘，有多项 | attachments | |
| projectID | String | 资源所属企业项目ID | 0 | |
| isEncrypt | Boolean | 是否加密盘 | false | |
| kmsUUID | String | 加密盘密钥UUID，是加密盘时才返回 | b6e2966d-7b1c-385e-abe4-d940caa273b7 | |
| onDemand | Boolean | 是否按需订购，按需时才返回该字段 | ||
| cycleType | String | month/year，非按需时返回 | year | |
| cycleCount | Integer | 包周期数，非按需时返回 | 2 | |
| regionID | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| azName | String | 可用区名称 | az1 | |
| diskFreeze | Boolean | 是否冻结 | false | |
| resourceUUID | String | 云硬盘ID |
表 attachments
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| instanceUUID | String | 绑定云主机ID | b6e2966d-7b1c-385e-abe4-d940caa273b7 | |
| attachmentID | String | 挂载ID | 4c44b4b4-5500-4599-ae6c-0b1b65d97f94 | |
| device | String | 挂载设备名，比如/dev/sda | /dev/vda |
枚举参数
无
请求示例
请求url
/v4/ecs/volume_show?regionID=81f7728662dd11ec810800155d307d5b&resourceID=4abf5a9e-271c-4b15-bdee-c4187fbe4531
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"updateTime": 1689821340000,
"diskFreeze": false,
"attachments": [
{
"device": "/dev/vdb",
"attachmentID": "48d54cfb-6c19-4e79-9f26-a7c96ad51166",
"instanceUUID": "1ee0d17a-bb09-3d83-fb72-e939faaa3583"
}
],
"projectID": "0",
"isEncrypt": false,
"instanceUUID": "1ee0d17a-bb09-3d83-fb72-e939faaa3583",
"instanceStatus": "running",
"resourceID": "504ca977285a42e4a22526c825df24fb",
"regionID": "bb9fdb42056f11eda1610242ac110002",
"diskSize": 10,
"resourceUUID": "908e83c1-1835-4b42-8206-b2353d75852a",
"instanceName": "zxTs-0719124000-0044",
"cycleCount": 1,
"diskMode": "VBD",
"expireTime": 1692498250000,
"cycleType": "month",
"azName": "cn-huadong1-jsnj1A-public-ctcloud",
"diskStatus": "in-use",
"createTime": 1689819837000,
"name": "volume01",
"multiAttach": true,
"diskType": "SATA",
"isPackaged": false
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
