卸载云硬盘

最近更新时间:2021-08-03 08:04:04

我的收藏

1. 接口描述

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

本接口(DetachDisks)用于卸载云硬盘。

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

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

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DetachDisks。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
DiskIds.N Array of String 将要卸载的云硬盘ID, 通过DescribeDisks接口查询,单次请求最多可卸载10块弹性云盘。
InstanceId String 对于非共享型云盘,会忽略该参数;对于共享型云盘,该参数表示要从哪个CVM实例上卸载云盘。

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 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.ResourceOpFailed 对资源的操作失败,具体错误信息请查看错误描述 Message 字段,稍后重试或者联系客服人员帮忙解决。
InvalidDisk.NotPortable 不支持非弹性云盘。
InvalidDisk.NotSupported 云硬盘不支持该操作。
InvalidDisk.TypeError 云硬盘类型错误。
InvalidDiskId.NotFound 输入的DiskId不存在。
InvalidInstance.NotSupported 云服务器不支持挂载云盘。
InvalidInstanceId.NotFound 输入实例的InstanceId不存在。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.LimitExceeded 参数值数量超过限制。
MissingParameter 缺少参数错误。
ResourceBusy 资源繁忙,请稍后重试。
ResourceInUse.DiskMigrating 云硬盘当前已在迁移中,请稍后重试。
ResourceNotFound.NotFound 资源不存在。
ResourceUnavailable.NotPortable 非弹性云硬盘不支持此操作。
ResourceUnavailable.NotSupported 资源不支持此操作。
ResourceUnavailable.TypeError 云硬盘类型错误,如尝试挂载系统盘至云服务器上。
UnauthorizedOperation.MFAExpired MFA鉴权过期,请重试。
目录