接口介绍
基于磁盘ID查询云硬盘详情。
接口约束
1、支持的线上资源池:一类节点均支持;
URI
GET /v4/ebs/info-ebs
Query参数
表query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
diskID | 是 | String | 磁盘ID。 | 参考请求示例 | |
regionID | 否 | String | 如本地语境支持保存regionID,那么建议传递。 | 参考请求示例 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回状态码(800为成功,900为失败) | ||
message | 是 | String | 失败时的错误描述,一般为英文描述 | ||
description | 是 | String | 失败时的错误描述,一般为中文描述 | ||
returnObj | 是 | Object | 参考表returnObj | 参考表returnObj | |
errorCode | 是 | String | 业务细分码,为product.module.code三段式码. |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
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,是加密盘时才返回 | ||
onDemand | 是 | Boolean | 是否按需订购,按需时才返回该字段 | ||
cycleType | 是 | String | month/year,非按需时返回 | ||
cycleCount | 是 | Integer | 包周期数,非按需时返回 | ||
regionID | 是 | String | 资源池ID | ||
azName | 是 | String | 多可用区下的可用区名字 |
表 attachment
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
instanceID | 是 | String | 绑定云主机实例UUID | ||
attachmentID | 是 | String | 挂载ID | ||
device | 是 | String | 挂载设备名,比如/dev/sda |
请求示例
请求头header示例
{
}
请求url示例
.../v4/ebs/info-ebs?regionID=81f7728662dd11ec810800155d307d5b&diskID=0ae97ef5-6ee2-44af-9d05-1a509b0a1be6
请求体body示例
无
响应示例
{
"returnObj": {
"diskName": "ebs-newspec-test0211v7",
"isPackaged": false,
"diskMode": "VBD",
"multiAttach": false,
"projectID": "0",
"regionID": "81f7728662dd11ec810800155d307d5b",
"updateTime": 1676081845000,
"diskType": "SATA",
"expireTime": 1678501018000,
"isEncrypt": false,
"cycleType": "month",
"diskSize": 10,
"azName": "az2",
"diskStatus": "available",
"createTime": 1676081790000,
"diskID": "0ae97ef5-6ee2-44af-9d05-1a509b0a1be6",
"cycleCount": 1
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功。 |
错误码
请参考通用结果码。