接口功能介绍
支持将某一云硬盘从云主机卸载。
接口约束
1、只有数据盘支持卸载操作，系统盘不支持卸载；
接口是否审批
否
URI
POST JSON /v4/ebs/detach-ebs
Content-Type
application/json
路径参数
无
Query参数
无
请求头header参数
无
请求参数
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| diskID | 是 | String | 磁盘ID。 | eff436e3d44040f1b306ab3a14530f02 | |
| regionID | 否 | String | 如本地语境支持保存regionID，那么建议传递。 | 41f64827f25f468595ffa3a5deb5d15d | |
| instanceID | 否 | String | 云主机ID，用于共享盘指定卸载某个主机。 | sdff234d4dfs48950f1b45sd02132554 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | 800 | |
| message | String | 失败时的错误描述，一般为英文描述 | region info empty | |
| description | String | 失败时的错误描述，一般为中文描述 | 资源池信息为空 | |
| returnObj | Object | 返回结构体 | returnObj | |
| errorCode | String | 业务细分码，为product.module.code三段式码.请参考错误码 | ebs.regionInfo.empty | |
| error | String | 业务细分码，为product.module.code三段式大驼峰码. 请参考错误码 | Ebs.RegionInfo.Empty | |
| errorDetail | Object | 错误明细。一般情况下，会对订单侧(bss)的云硬盘订单业务相关的错误做明确的错误映射和提升，有唯一对应的errorCode。 其他订单侧(bss)的错误，以Ebs.Order.ProcFailed的errorCode统一映射返回，并在errorDetail中返回订单侧的详细错误信息 |
errorDetail |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| diskJobID | String | 异步任务ID，可通过公共接口查询/v4/job/info该jobID来查看异步任务最终执行结果（该参数即将被弃用，为提高兼容性，请尽量使用diskRequestID参数） | 3641b283-0345-49a9-9c86-bebd963f1caa | |
| diskRequestID | String | 异步任务ID，可通过公共接口查询/v4/job/info该jobID来查看异步任务最终执行结果 | 3641b283-0345-49a9-9c86-bebd963f1caa |
表 errorDetail
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| bssErrCode | String | bss错误明细码，包含于bss格式化JSON错误信息中 | bss.xxx.xxx | |
| bssErrMsg | String | bss错误信息，包含于bss格式化JSON错误信息中 | 账号验证失败 | |
| bssOrigErr | String | 无法明确解码bss错误信息时，原样透出的bss错误信息 | get account info failed | |
| bssErrPrefixHint | String | bss格式化JSON错误信息的前置提示信息 | get account info failed |
请求示例
请求头header
{
}
请求体body
{
"diskID": "eff436e3d44040f1b306ab3a14530f02",
"regionID": "41f64827f25f468595ffa3a5deb5d15d",
}
响应示例
{
"returnObj":{
"diskJobID":"3641b283-0345-49a9-9c86-bebd963f1caa",
"diskRequestID":"3641b283-0345-49a9-9c86-bebd963f1caa"
},
"message":"SUCCESS",
"description":"成功",
"statusCode":800
}
状态码
请参考状态码
