Help Center/ Cloud Search Service/ API Reference (ME-Abu Dhabi Region)/ Cluster Management/ Renaming a Cluster
Updated on 2023-06-20 GMT+08:00
View PDF
Share

Renaming a Cluster

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.

cluster_id

Yes

String

ID of the cluster that you want to rename.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

displayName

Yes

String

New name of a cluster

Response Parameters

None

Example Requests

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

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