DetachDisks

DetachDisks

1. 接口描述

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

注意事项

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

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

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

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

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

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

2. 请求参数

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

参数名称
必选
类型
描述

diskIds

Array of String

将要卸载的云硬盘ID集合。

instanceCheckFlag

Boolean

是否检测实例的运行状态。 默认为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": "T86A56634-582A-4615-BBE2-ABFE192EE7CE",
  "response": {
    "requestId": "T86A56634-582A-4615-BBE2-ABFE192EE7CE"
  }
}

5. 开发者工具

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

6. 错误码

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

HTTP状态码
错误码
说明

400

INVALID_DISK_NOT_PORTABLE

指定的云硬盘不可移动。

400

UNSUPPORTED_OPERATION_DISK_STATUS

指定的云硬盘当前状态不支持该操作。

400

UNSUPPORTED_OPERATION_INSTANCE_STATUS

指定的实例当前状态不支持该操作。

400

UNSUPPORTED_OPERATION_DISK_SYSTEM_TYPE

指定的云硬盘为系统盘不支持该操作。

400

UNSUPPORTED_OPERATION_DISK_NO_ATTACH

指定的云硬盘没有挂载到实例。

400

UNSUPPORTED_OPERATION_DISK_BELONG_MULTIPLE_INSTANCE

指定的多个云硬盘归属于不同实例。

最后更新于