挂载云硬盘
最近更新时间: 2024-10-18 10:38:44
1. 接口描述
接口请求域名： cbs.api3.fincloud.tencent.cn。
本接口（AttachDisks）用于挂载云硬盘。
- 支持批量操作，将多块云盘挂载到同一云主机。如果多个云盘存在不允许挂载的云盘，则操作不执行，以返回特定的错误码返回。
- 本接口为异步接口，当挂载云盘的请求成功返回时，表示后台已发起挂载云盘的操作，可通过接口DescribeDisks来查询对应云盘的状态，如果云盘的状态由“ATTACHING”变为“ATTACHED”，则为挂载成功。
默认接口请求频率限制：20次/秒。
接口更新时间：2020-02-19 14:50:43。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：AttachDisks |
| Version | 是 | 否 | String | 公共参数，本接口取值：2017-03-12 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| DiskIds | 是 | 否 | Array of String | 将要被挂载的弹性云盘ID。通过DescribeDisks接口查询。单次最多可挂载10块弹性云盘。 |
| InstanceId | 是 | 否 | String | 云服务器实例ID。云盘将被挂载到此云服务器上，通过DescribeInstances接口查询。 |
| AlignType | 否 | 否 | String | 此参数对外不可见。 可选参数，不传该参数则仅执行挂载操作。<br>传入该参数，会在挂载时将云盘的生命周期与待挂载主机对齐。取值范围：<br><li>AUTO_RENEW：云盘未设置自动续费时，可传该值，将云盘设置为自动续费。<br><li> DEADLINE_ALIGN：当云盘的到期时间早于待挂载主机，可传该值，将云盘的到期时间与主机对齐。 |
| DeleteWithInstance | 否 | 否 | Bool | 可选参数，不传该参数则仅执行挂载操作。传入True时，会在挂载成功后将云硬盘设置为随云主机销毁模式，仅对按量计费云硬盘有效。 |
| InstanceIds | 否 | 否 | Array of String | 此参数对外不可见。 可选参数，用于控制台批量挂载共享盘到多个CVM时指定实例ID。如果传入多个InstanceId，那么DisksId中指定的云盘必须全部为共享云盘，否则返回错误。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| ZoneNotMatch | |
| InvalidDisk.NotPortable | |
| InvalidDisk.TypeError | |
| InvalidInstance.NotSupported | |
| InvalidInstanceId.NotFound | |
| InvalidParameterValue.LimitExceeded | |
| InvalidDisk.Attached | |
| InternalError.ResourceOpFailed | |
| InvalidDiskId.NotFound | |
| InvalidParameterValue | |
| MissingParameter | |
| InvalidDisk.NotSupported |