Tenant Cloud Storage Cloud Block Storage Cloud Disk APIs SwitchParameterCreateDisks

SwitchParameterCreateDisks

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

1. Interface Description

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

This API (SwitchParameterCreateDisks) is used to obtain order parameters for creating cloud disks.

Default interface request rate limit: 20 times per second.

Interface update time: 2024-07-16 06:58:53.

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: SwitchParameterCreateDisks
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
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: 10
    		•
    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_BASIC
    		•
    DiskCount No No Uint64 Number of cloud disks purchased. 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. The default value is 1.
    Example: 1
    DiskChargeType Yes No String Payment mode. Currently, the only option is PREPAID.
    Example: PREPAID
    DiskUsage No No String It specifies to create a system disk or data disk. Value range:
  • SYSTEM_DISK: system disk
  • DATA_DISK: data disk.
    Example: DATA_DISK
    		•
    DiskChargePrepaid Yes No DiskChargePrepaid Prepaid mode, that is, the settings for the monthly subscription-related parameters. This parameter allows specifying the purchase duration of the monthly subscribed cloud disk, and whether to set auto-renewal, among other attributes.
    Example:View
    Placement Yes No Placement The location of cloud disk. This parameter can specify the cloud disk availability zone and project. If the project is not specified, the cloud disk will be created under the default project.
    Example:View
    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
    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: Untitled
    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
    AutoSnapshotPolicyId No No String ID of the regular snapshot policy. When this parameter is input, the cloud disk will automatically be associated with the specified regular snapshot policy upon successful creation.
    Example: asp-mrsrn243
    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
    DiskStoragePoolGroup No No String Resource Pool Group
    Example: pool-ec
    PlatformProjectId No No String Project ID
    Example: pr-42749a13

    3. Output Parameters

    Parameter name Type Description
    DiskOrder Array of DiskOrder Billing order parameters.
    Example:View
    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
    MissingParameter Missing parameter. The request does not include the mandatory parameter.
    InvalidParameterValue Invalid parameter value. The format of the parameter value is incorrect or the parameter value is not supported.