Help Center/ Workspace/ API Reference/ Workspace APIs/ Disk/ Adds a disk to the desktop.

Updated on 2024-01-10 GMT+08:00

View PDF

Adds a disk to the desktop.

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

POST /v2/{project_id}/volumes

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

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	No	String	MIME type of the request body.
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API that is used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

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

**Table 4** 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 5** 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
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.

Status code: 200

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

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 401

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 403

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 404

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 409

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 500

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

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

Status code: 200

Normal.

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

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