云硬盘信息查询
接口功能介绍
基于磁盘ID查询云硬盘详情
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
接口约束
无
URI
GET /v4/ecs/volume/show
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
diskID | 是 | String | 磁盘ID,您可以查看产品定义-云硬盘来了解云硬盘 获取: 查 云硬盘列表查询创 创建云硬盘 |
fb86623a-3dd4-4ae4-9729-14f3b60809fc | |
regionID | 否 | String | 如本地语境支持保存regionID,那么建议传递。资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为处理中或失败) | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码,详见错误码说明 | Ebs.RegionInfo.AccessFailed | |
message | String | 失败时的错误描述,一般为英文描述 | Param is null | |
description | String | 失败时的错误描述,一般为中文描述 | 请求为空 | |
returnObj | Object | 返回参数 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
diskName | String | 磁盘名 | update-1009175254099508 | |
diskID | String | 磁盘ID | fb86623a-3dd4-4ae4-9729-14f3b60809fc | |
diskSize | Integer | 磁盘大小(GB) | 20 | |
diskType | String | 磁盘规格类型 SATA/SAS/SSD-genric/SSD/FAST-SSD | SATA | |
diskMode | String | 磁盘模式。VBD/ISCSI/FCSAN | VBD | |
diskStatus | String | 云硬盘使用状态 deleting/creating/detaching,具体请参考云硬盘使用状态 | available | |
createTime | Integer | 创建时刻,epoch时戳,精度毫秒 | 1696844760000 | |
updateTime | Integer | 更新时刻,epoch时戳,精度毫秒 | 1696845349000 | |
expireTime | Integer | 过期时刻,epoch时戳,精度毫秒 | null | |
isSystemVolume | Boolean | 是否系统盘,只有为系统盘时才返回该字段 | false | |
isPackaged | Boolean | 是否是云主机成套资源 | false | |
instanceName | String | 绑定的云主机名,有挂载时才返回 | api-test01 | |
instanceID | String | 绑定云主机resourceUUID,有挂载时才返回 | 755a72c6-ea40-ce04-7ad8-c9f54d38ccfd | |
instanceStatus | String | 云主机状态starting/restarting/stopping,具体参考云主机状态(有挂载时才返回) | starting | |
multiAttach | Boolean | 是否共享云硬盘 | false | |
attachments | ObjectArray | 挂载信息。如果是共享挂载云硬盘,有多项 | 参考表attachment | |
projectID | String | 资源所属企业项目ID | 0 | |
isEncrypt | Boolean | 是否加密盘 | false | |
kmsUUID | String | 加密盘密钥UUID,是加密盘时才返回 | bbbbbbbb-cbe3840c-bda4-4102-b68f-98c9d7190d69 | |
onDemand | Boolean | 是否按需订购,按需时才返回该字段 | true | |
cycleType | String | month/year,非按需时返回 | MONTH | |
cycleCount | Integer | 包周期数,非按需时返回 | 1 | |
regionID | String | 资源池ID | bb9fdb42056f11eda1610242ac110002 | |
azName | String | 多可用区下的可用区名字 | cn-huadong1-jsnj1A-public-ctcloud |
表 attachments
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
instanceID | String | 绑定云主机实例UUID | 755a72c6-ea40-ce04-7ad8-c9f54d38ccfd | |
attachmentID | String | 挂载ID | d9528b9c-2226-4751-bcb1-f4613faad427 | |
device | String | 挂载设备名,比如/dev/sda | /dev/vda |
请求示例
请求头header
无
请求体body
示例:查询华东1资源池下一个云硬盘的详情信息
{
"regionID":"bb9fdb42056f11eda1610242ac110002",
"diskID":"fb86623a-3dd4-4ae4-9729-14f3b60809fc"
}
响应示例
{
"returnObj": {
"diskName": "update-1009175254099508",
"onDemand": true,
"diskFreeze": false,
"isPackaged": false,
"diskMode": "VBD",
"multiAttach": false,
"projectID": "0",
"regionID": "bb9fdb42056f11eda1610242ac110002",
"diskType": "SATA",
"expireTime": null,
"isEncrypt": false,
"diskSize": 20,
"azName": "az1",
"diskStatus": "available",
"updateTime": 1696845349000,
"createTime": 1696844760000,
"diskID": "fb86623a-3dd4-4ae4-9729-14f3b60809fc"
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
请参考通用结果码。