Tenant Cloud Storage Cloud Block Storage Cloud Disk APIs CreateDisks

CreateDisks

Last Updated At: 2026-08-02 00:04:24

1. Interface Description

Interface request domain name: cbs.api3.convergecloud.com.

This API is used to create a cloud disk.

  • The purchase of a prepaid cloud disk will deduct the amount required for the current purchase in advance. Ensure sufficient account balance before this API is called.
  • This API allows you to create a cloud disk by inputting a data disk snapshot and then copy snapshot data to the purchased cloud disk.
  • This API is asynchronous. When a creation request is successfully issued, a new cloud disk ID list is returned, but creation of the cloud disk is not immediately completed. The status of the corresponding cloud disk can be queried by DiskId through the DescribeDisks API. If the cloud disk is found in the UNATTACHED or ATTACHED state, it indicates that the cloud disk is created successfully.

Default interface request rate limit: 20 times per second.

Interface update time: 2025-08-28 17:42:50.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: CreateDisks
Version Yes No String Public parameter, The value of this interface: 2017-03-12
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
DiskType Yes No String Hard disk media type. Value range:
  • CLOUD_BASIC: common cloud disk
  • CLOUD_PREMIUM: high-performance cloud disk
  • CLOUD_SSD: SSD cloud disk.
    Example: CLOUD_SSD
    		•
    DiskName No No String Display name of the cloud disk. If not specified, it defaults to "unnamed". The maximum length cannot exceed 60 bytes.
    Example: HCC_System disk
    DiskCount No No Uint64 Number of cloud disks created. If this parameter is not input, the default value is 1. There is a limit on the maximum number of cloud disks that can be created in a single request. For details, see the cloud disk use limits.
    Example: 1
    DiskChargeType Yes No String Payment mode. Currently, the only option is PREPAID.
    Example: PREPAID
    DiskChargePrepaid No No DiskChargePrepaid Prepaid mode, that is, the settings for the monthly subscription-related parameters. Through this parameter, you can specify the purchase duration of the monthly subscribed cloud disk, whether to enable auto-renewal, and other attributes. It is a required parameter for creating a prepaid cloud disk.
    Example:View
    Placement Yes No Placement Location of the instance. By specifying this parameter, you can determine the instance availability zone and project. If the project is not specified, the instance will be created under the default project.
    Example:View
    DiskSize No No Uint64 Cloud disk size, in GB.
  • If SnapshotId is input, DiskSize is optional. In this case, the size of the new cloud disk will be the size of the snapshot.
  • If SnapshotId and DiskSize are both input, then the cloud disk size must be greater than or equal to the snapshot size.
  • The range of cloud disk sizes: Common cloud disk: 10 GB to 4000 GB; high performance cloud disk: 50 GB to 4000 GB; SSD cloud disk: 100 GB to 4000 GB. The step is 10 GB.
    Example: 500
    		•
    SnapshotId No No String Snapshot ID. If this parameter is input, a cloud disk is created based on this snapshot. The snapshot type must be a data disk snapshot. Snapshots can be queried through the DescribeSnapshots API. For details, see the explanation of the output parameter DiskUsage.
    Example: snap-4zgc8cnk
    ClientToken No No String A string used to ensure request idempotency. This string is generated by the client and must be unique among requests, with a maximum of 64 ASCII characters. If this parameter is not specified, the request idempotency cannot be guaranteed.
    Example: 5034dbd5ec5446161df12497be78934d1e89100910001
    Encrypt No No String Input this parameter to create an encrypted cloud disk. The value is fixed to ENCRYPT.
    Example: ENCRYPT
    Tags No No Array of Tag Tag to which cloud disks are bound.
    Example:View
    Shareable No No Bool Optional. The default value is False. When True is input, the cloud disk will be created as a shared cloud disk.
    Example: false
    AutoSnapshotPolicyId No No String Regular snapshot policy ID. When this parameter is input, the cloud disk will be automatically bound to the regular snapshot policy upon successful creation.
    Example: asp-mrsrn243
    DiskStoragePoolGroup No No String Storage Resource Pool Group
    Example: pool-ec
    PlatformProjectId No No String Project ID
    Example: pr-42749a13
    ThroughputPerformance No No Uint64 Optional. You can use this parameter to purchase additional performance for cloud disk.
    Currently, only ultra-fast cloud disk (CLOUD_TSSD) and enhanced SSD cloud disk (CLOUD_HSSD) are supported.
    Example: 100
    DiskBackupQuota No No Uint64 Number of cloud disk backup points.
    Example: 1
    BackupDisk No No Bool Whether to back up the data by using the snapshot during cloud disk termination.
    Example: false

    3. Output Parameters

    Parameter name Type Description
    DiskIdSet Array of String ID list of created cloud disks.
    Example: ["disk-lzrg2pwi"]
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    InvalidParameter.DiskConfigNotSupported The current region does not support the cloud disk of the current configuration.
    InvalidParameterValue Invalid parameter value. The format of the parameter value is incorrect or the parameter value is not supported.
    TradeDealConflict Order conflict.
    InternalError.ComponentError Third-party Component Error
    MissingParameter Missing parameter. The request does not include the mandatory parameter.
    ResourceInsufficient.OverQuota Insufficient quota