Domain name for API request: tcaplusdb.tencentcloudapi.com.
This API is used to rename a specified cluster.
A maximum of 20 requests can be initiated per second for this API.
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 Params. The value used for this API: ModifyClusterName. |
Version | Yes | String | Common Params. The value used for this API: 2019-08-23. |
Region | Yes | String | Common Params. 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 |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to rename a cluster with the specified ClusterId
.
POST / HTTP/1.1
Host: tcaplusdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyClusterName
<Common request parameters>
{
"ClusterName": "gz test PROTO",
"ClusterId": "5674209986"
}
{
"Response": {
"RequestId": "87562838-1eda-45f3-abda-59a704135fe7"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
Was this page helpful?