This API is used to change a cluster name.
PUT /v2/{project_id}/clusters/{cluster_id}/cluster-name
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
The project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
cluster_id |
Yes |
String |
The cluster ID. For details about how to obtain the cluster ID, see Obtaining a Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
cluster_name |
Yes |
String |
The new cluster name. |
Status code: 200
Parameter |
Type |
Description |
---|---|---|
result |
String |
The operation result of the mapping update request. Value **succeeded** indicates that the operation is successful, and value **failed** indicates that the operation fails. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
The error code. |
error_msg |
String |
The error message. |
Change the MRS cluster name to mrs_jdRU_dm01.
{ "cluster_name" : "mrs_jdRU_dm01" }
Status code: 200
The cluster name is changed.
{ "result" : "succeeded" }
See Status Codes.
See Error Code.