接口介绍
基于资源池ID和云硬盘名称查询云硬盘详情。
接口约束
1、支持的线上资源池：一类节点均支持；
URI
GET /v4/ebs/info-by-name
请求参数
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 参考请求示例 |
| name | 是 | String | 云盘名称 | 参考请求示例 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 返回状态码(800为成功，900为失败) | 参考响应示例 | |
| message | 是 | String | 失败时的错误描述，一般为英文描述 | 参考响应示例 | |
| description | 是 | String | 失败时的错误描述，一般为中文描述 | 参考响应示例 | |
| returnObj | 是 | Object | 参考：云硬盘信息查询-表returnObj | 参考响应示例 | 参考云硬盘信息查询-表returnObj |
| errorCode | 是 | String | 业务细分码，为product.module.code三段式码. 参考结果码 |
参考响应示例 |
请求示例
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"name": "yue4test"
}
响应示例
{
"returnObj": {
"projectID": "0",
"name": "yue4test",
"diskMode": "VBD",
"multiAttach": false,
"resourceID": "bbefa37711ad408094a45f0c537335bc",
"regionID": "81f7728662dd11ec810800155d307d5b",
"diskType": "SATA",
"expireTime": null,
"isEncrypt": false,
"cycleType": "month",
"diskSize": 10,
"isPackaged": false,
"azName": "az2",
"diskStatus": "available",
"resourceUUID": "7a3b0f55-f451-4eeb-8ae1-10521d25360c",
"createTime": 1667379637000,
"updateTime":1667379637000,
"cycleCount": 1200
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
错误码
请参考通用结果码。
