1. 接口描述
本接口(AttachCbsStorages)用于挂载指定的弹性云盘到指定的云服务器上。
接口请求域名:cbs.api.qcloud.com
使用限制:
- 只支持弹性云盘。云硬盘类型可以通过DescribeCbsStorages(查询云硬盘信息)接口查询,见输出参数中
portable
字段解释。 - 云硬盘必须处于非挂载状态,且状态为
normal
。云硬盘挂载状态可以通过DescribeCbsStorages(查询云硬盘信息)接口查询,见输出参数中storageStatus
、attached
字段解释。 - 云服务器已挂载弹性云盘数量可以通过DescribeInstancesCbsNum(查询云服务器已挂载弹性云盘数量)接口查询,见输出参数中
maxAttachNum
、count
字段解释。
2. 输入参数
以下请求参数列表仅列出了接口请求参数,其它参数见公共请求参数页面。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
storageIds | 是 | Array[String] | 将要被挂载的弹性云盘ID。通过DescribeCbsStorages(查询云硬盘信息)接口查询。单次请求最多可操作10块弹性云盘 |
uInstanceId | 是 | String | 云服务器实例ID,云盘将被挂载到此云服务器上。实例ID可通过DescribeInstances(查看实例列表)接口查询 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 公共错误码,0表示成功,其他值表示失败。详见错误码页面 |
message | String | 错误信息,详见错误码页面 |
detail | Array[object] | 详见批量异步任务接口返回格式 |
4. 错误码表
以下错误码表仅列出了该接口的业务逻辑错误码,更多公共错误码详见云硬盘错误码。
错误代码 | 英文描述 | 错误描述 |
---|---|---|
9003 | InvalidParameter | 参数错误 |
16007 | IncorrectInstanceStatus.DiskTypeInvalid | 当前云硬盘不支持此操作 |
16008 | IncorrectInstanceStatus.OnlySupportElasticCloudDisk | 只能处理弹性云盘 |
5. 示例
输入
https://cbs.api.qcloud.com/v2/index.php? <公共请求参数> &Action=AttachCbsStorages &storageIds.0=disk-a2dbffgk &uInstanceId=ins-9spojch6
输出
{
"code":"0",
"message":"",
"detail":{
"disk-a2dbffgk":{
"code":"0",
"message":"ok"
},
"taskId":"2377970"
}
}