Changing a Cluster Name

Function

This API is used to change the name of a cluster.

URI

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID and Name.

cluster_id

Yes

String

ID of the cluster that you want to rename

Request Parameters

Table 2 Request body parameter

Parameter

Mandatory

Type

Description

displayName

Yes

String

New cluster name

Response Parameters

None

Request Example

{
  "displayName" : "ES-Test-new"
}

Response Example

None

Status Codes

Status Code

Description

200

The request is processed successfully.

400

Invalid request.

Modify the request instead of retrying.

409

The request cannot be processed due to a conflict.

This status code indicates that the resource that the client attempts to create already exists, or the request fails to be processed because of the update of the conflict request.

412

The server does not meet one of the requirements that the requester puts on the request.