Function

This API is used to create one or multiple EVS disks. Enterprise project authorization is supported.

URI

• URI format

  POST /v3/{project_id}/cloudvolumes

• Parameter description

  Parameter	Mandatory	Description
  project_id	Yes	Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request

• Parameter description

  Parameter	Type	Mandatory	Description
  volume	Object	Yes	Specifies the information of the disks to be created. For details, see Parameters in the volume field.

• Parameters in the volume field

  Parameter	Type	Mandatory	Description
  backup_id	String	No	Specifies the ID of the backup that can be used to create a disk. This parameter is mandatory when you use a backup to create the disk. NOTE: For how to obtain the backup ID, see Querying All Backups.
  availability_zone	String	Yes	Specifies the AZ where you want to create the disk. If the AZ does not exist, the disk will fail to create. NOTE: For details about how to obtain the AZ, see Querying All AZs.
  description	String	No	Specifies the disk description. The value can contain a maximum of 255 bytes.
  size	Integer	No	Specifies the disk size, in GB. Its value can be as follows: System disk: 1 GB to 1024 GB Data disk: 10 GB to 32768 GB This parameter is mandatory when you create an empty disk. You can specify the parameter value as required within the value range. This parameter is mandatory when you create the disk from a snapshot. Ensure that the disk size is greater than or equal to the snapshot size. This parameter is mandatory when you create the disk from an image. Ensure that the disk size is greater than or equal to the minimum disk capacity required by min_disk in the image attributes. This parameter is optional when you create the disk from a backup. If this parameter is not specified, the disk size is equal to the backup size. NOTE: If the specified parameter value is a decimal, the integral part of the value is used by default when the request is sent.
  name	String	No	Specifies the disk name. If you create disks one by one, the name value is the disk name. The value can contain a maximum of 255 bytes. If you create multiple disks (the count value is greater than 1), the system automatically adds a hyphen followed by a four-digit incremental number, such as -0000, to the end of each disk name. For example, the disk names can be volume-0001 and volume-0002. The value can contain a maximum of 250 bytes.
  snapshot_id	String	No	Specifies the snapshot ID. If this parameter is specified, the disk is created from a snapshot. NOTE: For details about how to obtain the snapshot ID, see Querying Details About EVS Snapshots.
  imageRef	String	No	Specifies the image ID. If this parameter is specified, the disk is created from an image. NOTE: BMS system disks cannot be created from BMS images. For how to obtain the image ID, see Querying Images.
  volume_type	String	Yes	Specifies the disk type. Currently, the value can be SSD, GPSSD, or SAS. SSD: specifies the ultra-high I/O disk type. GPSSD: specifies the general purpose SSD disk type. SAS: specifies the high I/O disk type. If the specified disk type is not available in the AZ, the disk will fail to create. NOTE: If the disk is created from a snapshot, the volume_type field must be the same as that of the snapshot's source disk. For details about disk types, see Disk Types and Disk Performance.
  count	Integer	No	Specifies the number of disks to be created in a batch. If this parameter is not specified, only one disk is created. You can create a maximum of 100 disks in a batch. If disks are created from a backup, batch creation is not supported, and this parameter must be set to 1. NOTE: If the specified parameter value is a decimal, the integral part of the value is used by default when the request is sent.
  shareable	String	No	Specifies whether the disk is shareable. The value can be true (shared disk) or false (common disk). NOTE: This field is no longer used. Use multiattach.
  metadata	Object	No	Specifies the metadata of the created disk. The length of the key or value in the metadata cannot exceed 255 bytes. For details about metadata, see Parameters in the metadata field. Only the listed parameters can be specified when creating a disk. NOTE: Parameter values under metadata cannot be null.
  multiattach	Boolean	No	Specifies whether the disk is shareable. The default value is false. true: specifies a shared disk. false: specifies a non-shared disk. For more information, see Shared EVS Disks and Usage Instructions.
  tags	Object	No	Specifies the tags added to the disk during the disk creation. A maximum of 10 tags can be created for a disk. Tag keys of a tag must be unique. Deduplication will be performed for duplicate keys. Therefore, only one tag key in the duplicate keys is valid. Tag key: A tag key contains no more than 36 characters. It consists of letters, digits, underscores (_), hyphens (-), and Unicode characters (\u4E00-\u9FFF). Tag value: A tag value contains no more than 43 characters and can be an empty string. It consists of letters, digits, underscores (_), periods (.), hyphens (-), and Unicode characters (\u4E00-\u9FFF).
  enterprise_project_id	String	No	Specifies the enterprise project ID. This ID is associated with the disk during the disk creation. If it is not specified or set to 0, the resource is bound to the default enterprise project. NOTE: For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.

  

  Specifying either two of the backup_id, snapshot_id, and imageRef fields is not supported.

• Parameters in the metadata field

  Parameter	Type	Mandatory	Description
  __system__encrypted	String	No	Specifies the parameter that describes the encryption function in metadata. The value can be 0 (encryption function disabled) or 1 (encryption function enabled). If this parameter does not exist, the disk will not be encrypted by default.
  __system__cmkid	String	No	Specifies the parameter that describes the encryption CMK ID in metadata. This parameter is used together with __system__encrypted for encryption. The length of cmkid is fixed at 36 bytes. NOTE: For details about how to obtain the CMK ID, see Query the key list.
  hw:passthrough	String	No	If this parameter is set to true, the disk device type will be SCSI, which allows ECS OSs to directly access underlying storage media. SCSI reservation command is supported. If this parameter is set to false, the disk device type will be VBD, that is, Virtual Block Device, which supports only simple SCSI read/write commands. If this parameter does not exist, the disk device type will be VBD, the default type.
  full_clone	String	No	If the disk is created from a snapshot and linked cloning needs to be used, set this parameter to 0.

  

  When creating a disk, you can only specify the fields of metadata listed in the preceding table.

  • If the disk is created from a snapshot, __system__encrypted and __system__cmkid are not supported, and the newly created disk has the same encryption attribute as that of the snapshot's source disk.
  • If the disk is created from an image, __system__encrypted and __system__cmkid are not supported, and the newly created disk has the same encryption attribute as that of the image.
  • If the disk is created from a snapshot, hw:passthrough is not supported, and the newly created disk has the same device type as that of the snapshot's source disk.
  • If the disk is created from an image, hw:passthrough is not supported, and the device type of newly created disk is VBD.
• Example request

  {
      "volume": {
          "backup_id": null, 
          "count": 1, 
          "availability_zone": "az-dc-1", 
          "description": "test_volume_1", 
          "size": 120, 
          "name": "test_volume_1", 
          "volume_type": "SSD", 
          "metadata": {
              "__system__encrypted": "1", 
              "__system__cmkid": "37b0d52e-c249-40d6-83cb-2b93f22445bd"
          }
      }
  }

Response

• Parameter description

  Parameter	Type	Description
  job_id	String	Specifies the task ID. NOTE: For details about how to query the task status, see Querying Task Status.
  error	Object	Specifies the error message returned when an error occurs. For details, see Parameters in the error field.

• Parameters in the error field

  Parameter	Type	Description
  message	String	Specifies the error message returned when an error occurs.
  code	String	Specifies the error code returned when an error occurs. For details about the error code, see Error Codes.

• Example response

  {
      "job_id": "70a599e0-31e7-49b7-b260-868f441e862b"
  }

  or

  {
      "error": {
          "message": "XXXX", 
          "code": "XXX"
      }
  }

Status Codes

• Normal

  200

Error Codes

For details, see Error Codes.