Last updated: 2020-07-24 14:33:50

1. API Description

Domain name for API request:

This API is used to change the password of a specified cluster. The backend will allow the TcaplusDB SDK to access databases with both old and new passwords before the old password expires. You cannot submit a new password change request before the old password expires or submit a request to modify the expiration time of the old password after the old password expires.

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: ModifyClusterPassword.
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. This API only supports: ap-hongkong, ap-seoul, ap-shanghai, ap-singapore, ap-taipei, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley
ClusterId Yes String ID of the cluster for which to modify the password
OldPassword Yes String Old cluster password
OldPasswordExpireTime Yes Timestamp Expected expiration time of old cluster password
NewPassword Yes String New cluster password, which must contain lowercase letters (a-z), uppercase letters (A-Z), and digits (0-9).
Mode No String Update mode. 1: updates password, 2: updates old password expiration time. Default value: 1

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 Changing cluster password

This example shows you how to change a cluster password.

Input Example
&<common request parameters>

Output Example

  "Response": {
    "RequestId": "8cEcE3E8-2fE2-6d4b-5E34-Fdc01E35f2C6"

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.


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
FailedOperation.OldPasswordHasExpired The old password has expired.
FailedOperation.OldPasswordInUse The old password has not expired.
FailedOperation.PasswordFailure Incorrect password.
InternalError Internal error.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.InvalidTimeValue Invalid time format.
ResourceNotFound The resource does not exist.
UnsupportedOperation Unsupported operation.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback