解挂云硬盘

最近更新时间:2018-10-26 15:10:08

1. 接口描述

接口请求域名: cbs.tencentcloudapi.com 。

本接口(DetachDisks)用于解挂云硬盘。

  • 支持批量操作,解挂挂载在同一主机上的多块云盘。如果多块云盘存在不允许解挂载的云盘,则操作不执行,以返回特定的错误码返回。
  • 本接口为异步接口,当请求成功返回时,云盘并未立即从主机解挂载,可通过接口DescribeDisks来查询对应云盘的状态,如果云盘的状态由“ATTACHED”变为“UNATTACHED”,则为解挂载成功。

默认接口请求频率限制:20次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cbs.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DetachDisks
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
DiskIds.N Array of String 将要解挂的云硬盘ID, 通过DescribeDisks接口查询,单次请求最多可解挂10块弹性云盘。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 解挂单块云硬盘

输入示例

https://cbs.tencentcloudapi.com/?Action=DetachDisks
&DiskIds.0=disk-lzrg2pwi
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "aafa71a0-ed62-0fac-3ebf-5a1f808d1085"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
InternalError.ResourceOpFailed 对资源的操作失败,具体错误信息请查看错误描述 Message 字段,稍后重试或者联系客服人员帮忙解决。
InvalidDisk.NotPortable 不支持非弹性云盘
InvalidDisk.NotSupported 云硬盘不支持该操作。
InvalidDisk.TypeError 云硬盘类型错误。
InvalidDiskId.NotFound 输入的DiskId不存在。
InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
InvalidParameterValue.LimitExceeded 参数值数量超过限制。
MissingParameter 参数缺失。请求没有带必选参数。

如果有其他疑问,您也可以在问答社区中寻求帮助。前往问答社区 >