租户端 存储 云硬盘（CBS） 云硬盘相关接口 AttachDisks

AttachDisks

最近更新时间: 2024-12-21 13:01:30

1. 接口描述

接口请求域名： cbs.api3.gsesgpucloud.com。

本接口（AttachDisks）用于挂载云硬盘。

  • 支持批量操作，将多块云盘挂载到同一云主机。如果多个云盘存在不允许挂载的云盘，则操作不执行，以返回特定的错误码返回。
  • 本接口为异步接口，当挂载云盘的请求成功返回时，表示后台已发起挂载云盘的操作，可通过接口DescribeDisks来查询对应云盘的状态，如果云盘的状态由“ATTACHING”变为“ATTACHED”，则为挂载成功。

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

接口更新时间：2024-07-15 20:07:34。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：AttachDisks
Version 是 否 String 公共参数，本接口取值：2017-03-12
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
DiskIds 是 否 Array of String 将要被挂载的弹性云盘ID。通过DescribeDisks接口查询。单次最多可挂载10块弹性云盘。
示例值：
InstanceId 是 否 String 云服务器实例ID。云盘将被挂载到此云服务器上，通过DescribeInstances接口查询。
示例值：
AlignType 否 否 String 可选参数，不传该参数则仅执行挂载操作。
传入该参数，会在挂载时将云盘的生命周期与待挂载主机对齐。取值范围：
  • AUTO_RENEW：云盘未设置自动续费时，可传该值，将云盘设置为自动续费。
  •  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 输入实例的InstanceId不存在。
    InvalidParameterValue.LimitExceeded 参数值数量超过限制。
    InvalidDisk.Attached 云硬盘已挂载。
    InternalError.ResourceOpFailed 对资源的操作失败，具体错误信息请查看错误描述 Message 字段，稍后重试或者联系客服人员帮忙解决。
    InvalidDiskId.NotFound 输入的DiskId不存在。
    InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
    MissingParameter 参数缺失。请求没有带必选参数。
    InvalidDisk.NotSupported 云硬盘不支持该操作。