Help Center/ MapReduce Service/ API Reference (Ankara Region)/ API V2/ Cluster Management APIs/ Changing a Cluster Name
Updated on 2024-11-29 GMT+08:00
View PDF
Share

Changing a Cluster Name

Function

This API is used to change a cluster name.

URI

PUT /v2/{project_id}/clusters/{cluster_id}/cluster-name

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Constraints

N/A

Value range

The value must consist of 1 to 64 characters. Only letters and digits are allowed.

Default value

N/A

cluster_id

Yes

String

Explanation

The cluster ID. For details about how to obtain the cluster ID, see Obtaining a Cluster ID.

Constraints

N/A

Value range

The value can contain 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-).

Default value

N/A

Request Parameters

Table 2 Request body parameter

Parameter

Mandatory

Type

Description

cluster_name

Yes

String

Explanation

New cluster name.

Constraints

N/A

Value range

N/A

Default value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameter

Parameter

Type

Description

result

String

Explanation

Result of the request for updating a mapping.

Value range

  • succeeded: The operation is successful.
  • failed: The operation failed.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Explanation

Error code.

Value range

N/A

error_msg

String

Explanation

Error message.

Value range

N/A

Example Request

Change the MRS cluster name to mrs_jdRU_dm01.

{
  "cluster_name" : "mrs_jdRU_dm01"
}

Example Response

Status code: 200

The cluster name is changed.

{
  "result" : "succeeded"
}

Status Codes

See Status Codes.

Error Codes

See Error Codes.

Parent topic: Cluster Management APIs