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

SwitchParameterCreateDisks

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

1. 接口描述

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

本接口（SwitchParameterCreateDisks）用于得到创建云硬盘的订单参数。

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

接口更新时间：2024-07-15 22:58:53。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：SwitchParameterCreateDisks
Version 是 否 String 公共参数，本接口取值：2017-03-12
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
DiskSize 否 否 Uint64 云硬盘大小，单位为GB。
  • 如果传入SnapshotId则可不传DiskSize，此时新建云盘的大小为快照大小
  • 如果传入SnapshotId同时传入DiskSize，则云盘大小必须大于或等于快照大小
  • 云盘大小取值范围： 普通云硬盘:10GB  4000G；高性能云硬盘:50GB  4000GB；SSD云硬盘:100GB ~ 4000GB。步长均为10GB
    示例值：
    		•
    DiskType 是 否 String 硬盘介质类型。取值范围：
  • CLOUD_BASIC：表示普通云硬盘
  • CLOUD_PREMIUM：表示高性能云硬盘
  • CLOUD_SSD：表示SSD云硬盘。
    示例值：
    		•
    DiskCount 否 否 Uint64 购买数量。单次请求最多可创建的云盘数有限制，具体参见云硬盘使用限制。默认取值为1。
    示例值：
    DiskChargeType 是 否 String 付费模式，目前只有预付费，即只能取值为PREPAID。
    示例值：
    DiskUsage 否 否 String 指定创建系统盘或数据盘。取值范围：
  • SYSTEM_DISK：表示系统盘
  • DATA_DISK：表示数据盘。
    示例值：
    		•
    DiskChargePrepaid 是 否 DiskChargePrepaid 预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月云盘的购买时长、是否设置自动续费等属性。
    示例值：查看
    Placement 是 否 Placement 云硬盘所在的位置。通过该参数可以指定云硬盘所属可用区，所属项目。若不指定项目，将在默认项目下进行创建。
    示例值：查看
    SnapshotId 否 否 String 快照ID，如果传入则根据此快照创建云硬盘，快照类型必须为数据盘快照，可通过DescribeSnapshots接口查询快照，见输出参数DiskUsage解释。
    示例值：
    DiskName 否 否 String 云盘显示名称。不传则默认为“未命名”。最大长度不能超60个字节。
    示例值：
    Encrypt 否 否 String 传入该参数用于创建加密云盘，取值固定为ENCRYPT。
    示例值：
    Tags 否 否 Array of Tag 云盘绑定的标签。
    示例值：查看
    AutoSnapshotPolicyId 否 否 String 定期快照策略ID。传入此参数时，当云硬盘创建成功后将会自动绑定该定期快照策略
    示例值：
    Shareable 否 否 Bool 可选参数，默认为False。传入True时，云盘将创建为共享型云盘。
    示例值：
    DiskStoragePoolGroup 否 否 String 资源池组
    示例值：
    PlatformProjectId 否 否 String 项目ID
    示例值：

    3. 输出参数

    参数名称 类型 描述
    DiskOrder DiskOrder 计费订单参数。
    示例值：查看
    RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 错误码

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

    错误码 描述
    MissingParameter 参数缺失。请求没有带必选参数。
    InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。