PrevNext
search by keyword

Recent Pages

Documentation
TencentDB for Redis
    Documentation
    Download PDF

    ResetPassword

    Last updated: 2021-04-30 10:49:59
    Download PDF

    1. API Description

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

    This API is used to reset a password.

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

    Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: redis.ap-shanghai-fsi.tencentcloudapi.com

    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: ResetPassword.
    Version Yes String Common parameter. The value used for this API: 2018-04-12.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    InstanceId Yes String Redis instance ID
    Password No String Password reset (this parameter can be left blank when switching to password-free instance mode and is required in other cases)
    NoAuth No Boolean Whether to switch to password-free instance mode. false: switch to password-enabled instance mode; true: switch to password-free instance mode. Default value: false

    3. Output Parameters

    Parameter Name Type Description
    TaskId Integer Task ID (this parameter is the task ID when changing a password. If you are switching between password-free and password-enabled instance mode, you can leave this parameter alone)
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Sample request

    Input Example

    https://redis.tencentcloudapi.com/?Action=ResetPassword
&Password=zy456987
&InstanceId=crs-5a4py64p
&<Common request parameters>

    Output Example

    {
  "Response": {
    "RequestId": "137c2607-07d1-4df0-9978-4b57a7ca3465",
    "TaskId": 16657
  }
}

    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.
    InternalError.DbOperationFailed Internal system error with the database operation, which may be update, insert, select, etc.
    InvalidParameter Incorrect parameter.
    InvalidParameter.PermissionDenied The API has no CAM permissions.
    InvalidParameterValue.PasswordFreeDenied
    InvalidParameterValue.PasswordRuleError When the password is set, the old password passed in by MC does not match the previously set password.
    ResourceUnavailable.InstanceStatusAbnormal The Redis status is exceptional, and the corresponding process cannot be executed.
    UnauthorizedOperation.NoCAMAuthed No CAM permissions.
    tencent
    Copyright © 2013-2021 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy