Help Center/ Workspace/ API Reference/ Workspace APIs/ Disk/ Expands the disk capacity of a desktop.
Updated on 2024-01-10 GMT+08:00

Expands the disk capacity of a desktop.

Function

Expands the disk capacity of a desktop.

Debugging

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

URI

POST /v2/{project_id}/volumes/expand

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

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_expansion

No

Array of ExpandVolumesReq objects

Parameters for expanding the disk capacity.

Table 4 ExpandVolumesReq

Parameter

Mandatory

Type

Description

desktop_id

No

String

Desktop ID.

volume_id

No

String

Disk ID.

new_size

No

Integer

Disk size (GB) after capacity expansion.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

job_id

String

ID of the disk capacity expansion task.

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

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

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

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

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

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

Example Requests

{
  "desktop_volumes_expansion" : [ {
    "desktop_id" : "string",
    "volume_id" : "string",
    "new_size" : "integer"
  } ]
}

Example Responses

Status code: 200

Normal.

{
  "job_id" : "41162624-ba52-42f3-bdda-15c6d345ff60"
}

Status Codes

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.

Error Codes

See Error Codes.