Clear CRS Instance

Last updated: 2020-06-04 18:10:16

    Note:

    This is a legacy API which has been hidden and will no longer be updated. We recommend using the new Redis API 3.0 which is standardized and faster.

    1. API Description

    This API (ClearRedis) is used to clear a CRS instance.
    Domain name for API request: redis.api.qcloud.com

    2. Input Parameters

    The following request parameter list only provides API request parameters. Common request parameters are also needed when API is called. The Action field for this API is ClearRedis.

    Parameter Name Required Type Description
    redisId Yes String Instance ID
    password Yes String Instance password

    3. Output Parameters

    Parameter Name Type Description
    code Int Common error code; 0: Succeeded; other values: Failed
    message String Error message
    codeDesc String Description of error code at business side. For a successful operation, "Success" will be returned. In case of an error, a message describing the reason for the error will be returned.
    data Array Returned array

    Array data is composed as follows:

    Parameter Name Type Description
    data.requestId Int Task ID. You can use the API DescribeTaskInfo to query the task execution result

    4. Error Codes

    The following error codes include the business logic error codes for this API.

    Error Code Error Message Error Description
    11201 InvalidParameter Incorrect business parameter
    10701 InstanceNotExists No instance can be found for the serialId
    10707 InstanceLockedError The operation is impossible because the instance is locked
    10702 InstanceStatusAbnormal The operation is impossible due to an abnormal instance status. For example, the instance has a status of "in process" or "isolated" or "deleted"
    10501 PasswordEmpty Password is left empty
    10712 PasswordError Wrong password

    5. Example

      https://redis.api.qcloud.com/v2/index.php?Action=ClearRedis
        &redisId=crs-ifmymj41
        &password=49A2d!e@f12e
    

    The returned results are as below:

    {
        "code": 0,
        "message": "",
        "codeDesc": "Success",
        "data": {
            "requestId": 11965
        }
    }

    Was this page helpful?

    Was this page helpful?

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