Updated on 2025-10-28 GMT+08:00

Modifying the Name of a Cloud Phone Server

Function

This API is to modify the name of a cloud phone server based on its ID.

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

PUT /v1/{project_id}/cloud-phone/servers/{server_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

server_id

Yes

String

Specifies the unique identifier of the cloud phone server.

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

server_name

Yes

String

Specifies the cloud phone server name, which can contain a maximum of 60 characters, including letters, digits, hyphens (-), and underscores (_).

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID, which is unique.

error_msg

String

Specifies the error message returned for the task.

error_code

String

Specifies the task error code.

Example Requests

Modifying the name of a cloud phone server

PUT https://{CPH Endpoint}/v1/{project_id}/cloud-phone/servers/1564567b8bab40f34711234cb80d8574

{
  "server_name" : "newName"
}

Example Responses

Status code: 200

OK

{
  "request_id" : "135d898e69344a13925a0899e1a4ac53"
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.