创建云硬盘

最近更新时间: 2026-11-06 00:09:12

1. 接口描述

接口请求域名： cbs.api3.fincloud.tencent.cn。

本接口（CreateDisks）用于创建云硬盘。

  • 预付费云盘的购买会预先扣除本次云盘购买所需金额，在调用本接口前请确保账户余额充足。
  • 本接口支持传入数据盘快照来创建云盘，实现将快照数据复制到新购云盘上。
  • 本接口为异步接口，当创建请求下发成功后会返回一个新建的云盘ID列表，此时云盘的创建并未立即完成。可以通过调用DescribeDisks接口根据DiskId查询对应云盘，如果能查到云盘，且状态为'UNATTACHED'或'ATTACHED'，则表示创建成功。

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

接口更新时间：2026-04-20 16:14:56。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：CreateDisks
Version 是 否 String 公共参数，本接口取值：2017-03-12
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
DiskType 是 否 String 硬盘介质类型。取值范围：
  • CLOUD_BASIC：表示普通云硬盘
  • CLOUD_PREMIUM：表示高性能云硬盘
  • CLOUD_SSD：表示SSD云硬盘。
    示例值： CLOUD_HSSD
    		•
    DiskName 否 否 String 云盘显示名称。不传则默认为“未命名”。最大长度不能超60个字节。
    示例值： imc-fs9x0bv9
    DiskCount 否 否 Uint64 创建云硬盘数量，不传则默认为1。单次请求最多可创建的云盘数有限制，具体参见 云硬盘使用限制。
    示例值： 1
    DiskChargeType 是 否 String 付费模式，目前只有预付费，即只能取值为PREPAID。
    示例值： PREPAID
    DiskChargePrepaid 否 否 DiskChargePrepaid 预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月云盘的购买时长、是否设置自动续费等属性，创建预付费云盘该参数必传。
    示例值：查看
    Placement 是 否 Placement 实例所在的位置。通过该参数可以指定实例所属可用区，所属项目。若不指定项目，将在默认项目下进行创建。
    示例值：查看
    DiskSize 否 否 Uint64 云硬盘大小，单位为GB。
  • 如果传入SnapshotId则可不传DiskSize，此时新建云盘的大小为快照大小
  • 如果传入SnapshotId同时传入DiskSize，则云盘大小必须大于或等于快照大小
  • 云盘大小取值范围： 普通云硬盘:10GB  4000G；高性能云硬盘:50GB  4000GB；SSD云硬盘:100GB ~ 4000GB。步长均为10GB
    示例值： 500
    		•
    SnapshotId 否 否 String 快照ID，如果传入则根据此快照创建云硬盘，快照类型必须为数据盘快照，可通过DescribeSnapshots接口查询快照，见输出参数DiskUsage解释。
    示例值： snap-6mzlaea9
    ClientToken 否 否 String 用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。
    示例值： cls-juig7fub/pvc-920a4c2f-7e1f-40d5-a475-93c6871b18b4
    Encrypt 否 否 String 传入该参数用于创建加密云盘，取值固定为ENCRYPT。
    示例值： ENCRYPT
    Tags 否 否 Array of Tag 云盘绑定的标签。
    示例值：查看
    Shareable 否 否 Bool 可选参数，默认为False。传入True时，云盘将创建为共享型云盘。
    示例值： true
    AutoSnapshotPolicyId 否 否 String 定期快照策略ID。传入该参数时，云硬盘创建成功后将会自动绑定该定期快照策略
    示例值： "asp-o05sr7at"
    DiskStoragePoolGroup 否 否 String 存储资源池组
    示例值： pool_btv
    PlatformProjectId 否 否 String 项目ID
    示例值： og-qwerasdf
    ThroughputPerformance 否 否 Uint64 可选参数。使用此参数可给云硬盘购买额外的性能。
    当前仅支持极速型云盘（CLOUD_TSSD）和增强型SSD云硬盘（CLOUD_HSSD）。
    示例值： 100
    DiskBackupQuota 否 否 Uint64 云盘备份点个数
    示例值： 0
    BackupDisk 否 否 Bool 云盘销毁时是否通过快照备份数据
    示例值： true

    3. 输出参数

    参数名称 类型 描述
    DiskIdSet Array of String 创建的云硬盘ID列表。
    示例值： ["disk-lzrg2pwi"]
    RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 错误码

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

    错误码 描述
    InvalidParameter.DiskConfigNotSupported 当前地域不支持当前配置的云盘。
    InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
    TradeDealConflict 订单冲突。
    InternalError.ComponentError 第三方组件错误
    MissingParameter 参数缺失。请求没有带必选参数。
    ResourceInsufficient.OverQuota 配额不足
    InvalidAccount.InsufficientBalance 账户余额不足。

    5. 示例

    示例1 根据快照新建云硬盘

    传入快照创建云硬盘，未传DiskSize参数，此时新购云盘的大小为快照大小，新购云盘复制了快照数据。

    输入示例

    POST / HTTP/1.1
Host: cbs.api3.fincloud.tencent.cn
Content-Type: application/json
X-TC-Action: CreateDisks
<Common Parameters>

{
    "Placement": {
        "ProjectId": 0,
        "Zone": "ap-region-2"
    },
    "DiskChargeType": "PREPAID",
    "DiskCount": 1,
    "DiskType": "CLOUD_HSSD",
    "DiskChargePrepaid": {
        "RenewFlag": "NOTIFY_AND_AUTO_RENEW",
        "Period": 1
    },
    "SnapshotId": "snap-iepc4w3h"
}

    输出示例

    {
    "Response": {
        "DiskIdSet": [
            "disk-6rz0ilvu"
        ],
        "RequestId": "5e93a212-ca01-0fdc-eedd-5a1fce5e83e6"
    }
}

    示例2 创建按小时后付费云盘

    在region1三区创建一块云硬盘，云盘类型为高性能云硬盘，大小100GiB，付费类型为按小时后付费。

    输入示例

    POST / HTTP/1.1
Host: cbs.api3.fincloud.tencent.cn
Content-Type: application/json
X-TC-Action: CreateDisks
<Common Parameters>

{
    "DiskName": "postPayDisk",
    "Placement": {
        "ProjectId": 0,
        "Zone": "ap-region-3"
    },
    "DiskChargeType": "POSTPAID_BY_HOUR",
    "DiskCount": 1,
    "DiskType": "CLOUD_PREMIUM",
    "DiskSize": 100
}

    输出示例

    {
    "Response": {
        "DiskIdSet": [
            "disk-ecjc4cpw"
        ],
        "RequestId": "fe2274fa-eaec-4009-807b-6ffc00963fec"
    }
}

    示例3 使用基本参数购买

    新购云盘具体配置如下：云盘所在位置为region1三区，云盘大小50GiB，云盘类型为普通云盘，所属项目ID为0，付费模式为预付费，购买时长1个月，通知过期且自动续费。

    输入示例

    POST / HTTP/1.1
Host: cbs.api3.fincloud.tencent.cn
Content-Type: application/json
X-TC-Action: CreateDisks
<Common Parameters>

{
    "Placement": {
        "ProjectId": 0,
        "Zone": "ap-region-2"
    },
    "DiskChargeType": "PREPAID",
    "DiskCount": 1,
    "DiskType": "CLOUD_HSSD",
    "ThroughputPerformance": 100,
    "DiskSize": 500,
    "DiskChargePrepaid": {
        "RenewFlag": "NOTIFY_AND_AUTO_RENEW",
        "Period": 1
    }
}

    输出示例

    {
    "Response": {
        "DiskIdSet": [
            "disk-lzrg2pwi"
        ],
    "RequestId":  "6a57da9a-2049-7182-2de3-5a1f8014ccfd"
    }
}