tencent cloud

All product documents
APIs
DocumentationAPIsTencentDB for Redis®Instance APIsModifyInstancePassword
ModifyInstancePassword
Last updated: 2024-12-04 11:20:11
ModifyInstancePassword
Last updated: 2024-12-04 11:20:11

1. API Description

Domain name for API request: redis.intl.tencentcloudapi.com.

This API is used to change the instance access password.

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 Params. The value used for this API: ModifyInstancePassword.
Version Yes String Common Params. The value used for this API: 2018-04-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String Specifies the instance ID. Example: crs-xjhsdj****. Log in to the TencentDB for Redis console and copy the instance ID in the instance list.
OldPassword Yes String Old password of the instance.
Password Yes String New password of the instance. The password complexity requirements are as follows:
- It can contain 8 to 30 characters. It is recommended to use a password of more than 12 characters.
- It cannot start with a forward slash (/).
- It should contain at least two of the following types: lowercase letters, uppercase letters, digits, and special characters (such as ()~!@#$%^&*-+=_|{}[]:;<>,.?/).

3. Output Parameters

Parameter Name Type Description
TaskId Integer Task ID.
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.

4. Example

Example1 Modifying Passwords

This example shows you how to reset the instance access password.

Input Example

https://redis.intl.tencentcloudapi.com/?Action=ModifiyInstancePassword
&InstanceId=crs-5a4p****
&OldPassword=zy45****
&Password=4569****
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "cca16225-a169-4f11-b1cf-13398200f604",
        "TaskId": 16661
    }
}

5. Developer Resources

SDK

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.SystemError Internal system error, which is irrelevant to the business.
InvalidParameter.EmptyParam The parameter is empty.
InvalidParameter.InvalidParameter Invalid service parameter.
InvalidParameter.PermissionDenied The API has no CAM permissions.
InvalidParameterValue.PasswordError Password verification error due to incorrect password.
InvalidParameterValue.PasswordRuleError When the password is set, the old password passed in by MC does not match the previously set password.
ResourceNotFound.InstanceNotExists No Redis instance is found by the serialId.
ResourceUnavailable.InstanceLockedError Redis has been locked by another process.
ResourceUnavailable.InstanceStatusAbnormal The Redis status is exceptional, and the corresponding process cannot be executed.
UnauthorizedOperation.NoCAMAuthed No CAM permissions.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 available.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon