Expanding the Data Disk of a Cloud Phone

Function

This API is used to expand data disks of a cloud phone.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

POST /v1/{project_id}/cloud-phone/phones/expand-volume

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. It can be obtained by calling an Identity and Access Management (IAM) API. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
phones	Yes	Array of PhoneDataVolumeSize objects	Specifies the cloud phone list.

**Table 4** PhoneDataVolumeSize
Parameter	Mandatory	Type	Description
phone_id	Yes	String	Specifies the cloud phone ID.
new_size	Yes	Integer	Specifies the new capacity of the cloud phone data disk after expansion, in GiB. The new capacity must be greater than or equal to the original capacity and less than the maximum allowed capacity, 32,768 GiB.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the unique request ID.
jobs	Array of PhoneJob objects	Specifies the task information.

**Table 6** PhoneJob
Parameter	Type	Description
phone_id	String	Specifies the unique ID of a cloud phone. This parameter is contained in tasks related to cloud phones.
job_id	String	Specifies the unique ID of a task.
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Example Requests

Expanding the data disk of a cloud phone

POST https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones/expand-volume

{
  "phones" : [ {
    "phone_id" : "ca6ae3158406452696deade1a1091250",
    "new_size" : 100
  } ]
}

Example Responses

Status code: 200

{
  "request_id" : "6837531fd3f54550927b930180a706bf",
  "jobs" : [ {
    "phone_id" : "1234567b8bab40ffb711234cb80d0234",
    "job_id" : "1564567b8bab40f34711234cb80d0123"
  }, {
    "phone_id" : "1678567b8bab40f93711234cb80d0764",
    "error_code" : "CPS.0004",
    "error_msg" : "Parameter: phone_id is invalid."
  } ]
}