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

Modifying the Name or Description of a Cluster

Function

This API is used to change the cluster name or description.

Constraints

The name change here does not affect the cluster's underlying name.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/changename

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. Constraints N/A Range Project ID of an account. The value contains 32 characters, consisting of lowercase letters and digits. Default Value N/A
cluster_id	Yes	String	Definition Cluster ID. For details about how to obtain the cluster ID, see Obtaining the Cluster ID. Constraints N/A Range The value is a UUID containing 36 characters. Default Value N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
display_name	Yes	String	Definition Modified cluster name. Constraints The parameters display_name and desc cannot both be null. Range 4 to 32 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The name must start with a letter. Default Value N/A
desc	No	String	Definition Cluster description. Constraints The parameters display_name and desc cannot both be null. Range Up to 128 characters. Default Value N/A

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Change the display name of the current cluster.

POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/changename

{
  "display_name" : "ES-Test-new",
  "desc" : "test1"
}

Example Responses

None

Status Codes

Status Code	Description
200	Request succeeded.
400	Invalid request. Modify the request before retry.
409	The request could not be completed due to a conflict with the current state of the resource. The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.
412	The server did not meet one of the preconditions contained in the request.

Error Codes

See Error Codes.

Parent topic: Cluster Management