Help Center/ Workspace/ API Reference/ Workspace APIs/ Disk/ Adding Desktop Disks in Batches

Updated on 2026-02-10 GMT+08:00

View PDF

Adding Desktop Disks in Batches

Function

Adds desktop disks in batches.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:volumes:batchAdd	Write	desktop	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-	kms:cmk:createGrant kms:cmk:listGrants kms:cmk:get kms:cmk:list

URI

POST /v2/{project_id}/volumes

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
desktop_volumes	No	Array of AddDesktopVolumesReq objects	Adds disk parameters.

**Table 3** AddDesktopVolumesReq
Parameter	Mandatory	Type	Description
desktop_id	No	String	Desktop ID.
volumes	No	Array of Volume objects	Information about the disks to be added. One desktop can contain a maximum of 10 data disks.

**Table 4** Volume
Parameter	Mandatory	Type	Description
type	Yes	String	Desktop data disk type, which must be the same as the disk type provided by the system. SAS: high I/O SSD: ultra-high I/O GPSSD: general-purpose SSD
size	Yes	Integer	Disk capacity in GB. The system disk size ranges from 80 to 32760, and the data disk size ranges from 10 to 32760. The value must be a multiple of 10.
iops	No	Integer	Number of read/write operations performed by an EVS disk per second.
throughput	No	Integer	Amount of data read from and written to an EVS disk per second.
kms_id	No	String	KMS key ID, which is used to encrypt the created disk.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
job_id	String	ID of the task for adding a disk.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 409

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

POST /v2/9565be6e740941c493b38a1f46ecae6f/volumes

{
  "desktop_volumes" : [ {
    "desktop_id" : "string",
    "volumes" : [ {
      "type" : "SAS",
      "size" : 80
    } ]
  } ]
}

Example Responses

Status code: 200

Normal.

{
  "job_id" : "1792d3eb-35c6-4e99-8381-abfc8e02126b"
}

Status Codes

Status Code	Description
200	Normal.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
409	Operation conflict.
500	An internal service error occurred. For details about the error code, see the error code description.