Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop Pools/ Adding Disks in Batches to the Desktop Pool

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

View PDF

Adding Disks in Batches to the Desktop Pool

Function

Add disks in batches to the desktop pool.

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:desktopPools:batchAddVolumes	Write	desktopPool *	-	-	kms:cmk:createGrant kms:cmk:listGrants kms:cmk:get kms:cmk:list

URI

POST /v2/{project_id}/desktop-pools/{pool_id}/volumes/batch-add

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
pool_id	Yes	String	Specifies the desktop pool ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
handle_type	No	String	Processing type. ONLY_FOR_EXPAND: only added desktops FOR_EXPAND_AND_IDLE: added and idle desktops FOR_EXPAND_AND_ALL: added and existing desktops
desktop_ids	No	Array of strings	Desktop ID.
volumes	No	Array of VolumeAddInfo objects	Added disks.

**Table 3** VolumeAddInfo
Parameter	Mandatory	Type	Description
id	No	String	Specifies the disk record ID. This parameter is mandatory when you delete or expand a disk.
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
size	Yes	Integer	Disk capacity, in GB. The value must be greater than the current disk capacity.
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.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
job_id	String	Task ID.

Status code: 400

**Table 5** 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 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: 403

**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: 404

**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: 409

**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: 500

**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.

Example Requests

POST /v2/0bec5db98280d2d02fd6c00c2de791ce/desktops-pools/a130ab3a-72bf-4b71-baa9-af4987c8e338/volumes/batch-add

{
  "volumes" : [ {
    "id" : "9969022b-557d-4c1e-b22f-e7736ebe30af",
    "type" : "SAS",
    "size" : 20
  } ]
}

Example Responses

Status code: 200

Normal.

{
  "job_id" : "abc85365-0b2e-4b4f-a091-f7db72072d4b"
}

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.