API文档
云服务器相关接口
云盘相关接口
卸载云盘

1. 卸载云盘

本接口用于卸载云盘。

  1. 本接口为异步接口。当卸载云盘请求下发成功后会返回一个异步任务进度信息(jobUuid)。通过 jobUuid 可以查询出当前异步任务执行情况。如果异步任务正在执行,返回的内容里 done=false、success=false,并有进度值显示;如果异步任务执行成功完成,返回的内容里 done=true、success=true;如果异步任务执行失败,返回的内容里 done=true,success=false。
  2. 本接口当前版本只支持单块云盘从指定云服务器上卸载。后续将支持多块云盘同时从同一云服务器卸载。

1.1. 接口说明

本接口所属服务类型为 ebs

本接口操作类型为 DetachDisks

1.1.1. 请求路径

POST {baseUrl}/v3/ebs/DetachDisks

1.1.2. 请求体

{
  "zoneCode": "cn-zhongwei-a",
  "ecsUuid": "eb4fc7cd-20ca-45be-ae7e-2eaba7bb0526",
  "ebsUuids": ["9d0a06b8-cd8a-4bd5-af8e-445b8b63b0e7"]
}

请求体内容说明

属性名属性类型是否必须默认值说明
zoneCodeString可用区编码
ecsUuidString云服务器UUID
ebsUuidList<String>云盘 UUID

1.1.3. 返回内容

{
    "code": 200,
    "message": "卸载EBS成功",
    "data": [
        {
            "jobUuid": "e0cf28dfb7774c6b9f4b1d0b68427bf6",
            "success": false,
            "progress": 0,
            "type": "DetachEBS",
            "done": false,
            "resourceUuid": "9d0a06b8-cd8a-4bd5-af8e-445b8b63b0e7"
        }
    ]
}

返回内容说明

属性名属性类型说明
codeInteger返回码。正常返回 200,异常返回500或其他业务错误码
messageString返回信息。
dataArray卸载结果

异步任务进度信息

属性名属性类型说明
jobUuidString异步任务唯一编码
successBoolean异步任务是否执行成功
progressDouble异步任务执行进度。0-100%
typeString异步任务类型
doneBoolean异步任务是否执行完成
resourceUuidString异步任务所处理的资源 Uuid