tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

ModfiyInstancePassword

最后更新时间：2024-04-03 11:33:07

    1. API Description

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

    This API is used to modify the access password for an instance.

    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: ModfiyInstancePassword.
    Version Yes String Common Params. The value used for this API: 2018-04-12.
    Region No String Common Params. This parameter is not required for this API.
    InstanceId Yes String Instance ID, such as "crs-xjhsdj****". Log in to the Redis console and copy the instance ID in the instance list.
    OldPassword Yes String Old password of an instance
    Password Yes String New instance password, which has the following requirements:
    - It must contain 8-30 characters, preferably 12 or more.
    - It cannot start with a slash (/)
    - It must contain two of the following three types: lowercase letters, uppercase letters, and symbols (()~!@#$%^&*-+=_|{}[]:;<>,.?/)

    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 the password

    This example shows you how to reset instance access password.

    Input Example

    https://redis.tencentcloudapi.com/?Action=ModfiyInstancePassword
&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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款