Product Overview
Benefits
Use Cases
Architecture
Regions
Domain name for API request: tcaplusdb.intl.tencentcloudapi.com.
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.
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: ModifyClusterPassword. |
| 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 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 |
| 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 modify a cluster password.
https://tcaplusdb.intl.tencentcloudapi.com/?Action=ModifyClusterPassword
&ClusterId=23311894780
&OldPassword=canmkdmk1215LM
&NewPassword=99c59cb345c61063db
&OldPasswordExpireTime=2020-09-22 00:00:00
&<Common request parameters>{
"Response": {
"RequestId": "8cEcE3E8-2fE2-6d4b-5E34-Fdc01E35f2C6"
}
}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 |
|---|---|
| FailedOperation | Operation failed. |
| 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. |
피드백