接口介绍
支持将某一云硬盘从云主机卸载。
接口约束
只有数据盘支持卸载操作,系统盘不支持卸载。
URI
POST JSON /v4/ebs/detach-ebs
请求参数
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
diskID | 是 | String | 磁盘ID。 | 参考请求示例 | |
regionID | 否 | String | 如本地语境支持保存regionID,那么建议传递。 | 参考请求示例 | |
instanceID | 否 | String | 云主机ID,用于共享盘指定卸载某个主机。 | 参考请求示例 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回状态码(800为成功,900为失败) | ||
message | 是 | String | 失败时的错误描述,一般为英文描述 | ||
description | 是 | String | 失败时的错误描述,一般为中文描述 | ||
returnObj | 是 | Object | 参考表returnObj | 参考表returnObj | |
errorCode | 是 | String | 业务细分码,为product.module.code三段式码. 参考通用结果码 |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
diskJobID | 是 | String | 异步任务ID,可通过公共接口查询/v4/job/info该jobID来查看异步任务最终执行结果 |
请求示例
请求头header
{
}
请求体body
{
"diskID": "eff436e3d44040f1b306ab3a14530f02",
"regionID": "41f64827f25f468595ffa3a5deb5d15d",
}
响应示例
{
"returnObj": {
"diskJobID": "3641b283-0345-49a9-9c86-bebd963f1caa"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功。 |
错误码
请参考通用结果码。