Last updated: 2021-04-23 17:21:42

1. API Description

Domain name for API request:

This API is used to rename a specified cluster.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: ModifyClusterName.
Version Yes String Common parameter. The value used for this API: 2019-08-23.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
ClusterId Yes String ID of the cluster to be renamed
ClusterName Yes String Cluster name to be changed to, which can contain up to 32 letters and digits

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Renaming a cluster

This example shows you how to rename a cluster with the specified ClusterId.

Input Example

Content-Type: application/json
X-TC-Action: ModifyClusterName
<Common request parameters>

    "ClusterName": "gz test PROTO",
    "ClusterId": "5674209986"

Output Example

  "Response": {
    "RequestId": "87562838-1eda-45f3-abda-59a704135fe7"

5. Developer Resources


TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure.UnauthorizedOperation API operation authentication error.
FailedOperation Operation failed.
FailedOperation.RegionMismatch The requested region does not match.
InternalError Internal error.
InvalidParameterValue.InvalidClusterName Invalid cluster name.
ResourceNotFound The resource does not exist.
ResourceUnavailable.DuplicateClusterName The cluster name already exists.