DetachDisks

1. 接口描述

本接口用于将云硬盘从主机实例上卸载。

注意事项

  • 卸载挂载在同一实例上的多块云盘。如果多块云盘中存在不允许卸载的云盘,则操作不执行

  • 只有当云硬盘状态为IN_USE时才允许卸载。

  • 只有当云硬盘可插拔为true才允许卸载。

  • 云硬盘类型为DATA时才允许卸载。

  • 单次最多可卸载10块云硬盘。

  • 本接口为异步接口,当请求成功返回时,云硬盘并未立即从主机卸载,可通过接口DescribeDisks来查询对应云硬盘的状态,如果云硬盘的状态由DETACHING变为AVAILABLE,则为卸载成功。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称
必选
类型
描述

diskIds

Array of String

要卸载的云盘ID列表。

instanceCheckFlag

Boolean

是否检测实例的运行状态。

默认为true,即实例关机才允许被卸载。

否则必须实例关机才能调用本接口。

默认值:true。

3. 响应结果

参数名称
类型
描述

requestId

String

唯一请求 ID。

每次请求都会返回。定位问题时需要提供该次请求的 requestId。

4. 代码示例

1. 从云主机实例上卸载单块或多块云硬盘。

POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DetachDisks
<Common Request Params>

Request:
{
  "diskIds": [
    "your-disk-id"
  ]
}

Response:
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3"
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集(SDK),未来会陆续支持更多开发语言,方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码,其他错误码见公共错误码

HTTP状态码
错误码
说明

404

INVALID_DISK_NOT_FOUND

云盘不存在。

400

INVALID_DISK_NOT_PORTABLE

云硬盘是系统盘,不支持该操作。

404

INVALID_INSTANCE_NOT_FOUND

服务器实例不存在。

400

OPERATION_DENIED_DISK_SYSTEM_TYPE

云盘类型是系统盘不支持该操作。

400

UNSUPPORTED_OPERATION_DISK_NO_ATTACH

云盘未绑定。

400

UNSUPPORTED_OPERATION_DISK_STATUS

云盘状态不允许操作。

400

UNSUPPORTED_OPERATION_INSTANCE_STATUS

实例状态不支持此操作。

最后更新于