Query Task List of CRS Instance

Last updated: 2020-06-04 18:24:12

    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 (GetRedisTaskList) is used to query the task list of 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 the API is called.The Action field for this API is GetRedisTaskList.

    Parameter Name Required Type Description
    limit Yes Int Length of a page
    offset Yes Int Current page number. Default is 0. For query APIs, a maximum number of returned records is generally set for a single query by default. To traverse all the resources, you need to use "limit" and "offset" for a paged query; For example, to query the 40 records between 110 and 149, you can set offset = 110 and limit = 40.
    redisId No String Instance ID, which can be obtained from redisId in the returned values of API DescribeRedis. Filtering tasks by instance ID is supported.
    redisId No String Instance name, which can be obtained from redisName in the returned values of API DescribeRedis. Filtering tasks by instance name is supported.
    beginTime No String Start time, such as: 2017-02-08 16:46:34. Query the list of tasks submitted within the time period of [beginTime, endTime].
    endTime No String End time, such as: 2017-02-08 19:09:26. Query the list of tasks submitted within the time period of [beginTime, endTime].
    taskStatus No Array Status (statuses) of one or more tasks (n represents the array subscript starting with 0). Filtering tasks by task status is supported. Task statuses are defined as follows:
    0: To be executed;
    1: Executing;
    2: Succeeded;
    3: Failed;
    -1: Execution Error
    taskType No Array Type(s) of one or more tasks (n represents the array subscript starting with 0). Filtering tasks by task type is supported. Task types are defined as follows:
    task_importRdb: Import Rdb;
    task_exportBackup: Export backup;
    task_restoreBackup: Restore an instance;
    task_restoreStream: Roll back an instance (cluster instances can be rolled back to any time point within the last three days, but the data for the last 10 minutes cannot be rolled back);
    task_backupInstance: Back up an instance;
    task_cleanInstance: Clear an instance;
    task_resizeInstance: Upgrade an instance

    3. Output Parameters

    Parameter Name Type Description
    code Int Common error code; 0: Succeeded; other values: Failed
    message String Error message description. A null value indicates a success
    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.
    totalCount Int Total number of tasks
    data Object Details of task list

    Parameter data indicates the details of task list, and is composed as follows:

    Parameter Name Type Description
    data.redisTaskSet Array Array of task details

    Parameter redisTaskSet indicates the array of task details, and is composed as follows:

    Parameter Name Type Description
    startTime String Submission time of the task, such as: 2017-02-10 16:56:18
    taskName String Task name:
    newInstance: Create an instance;
    resizeInstance: Upgrade an instance;
    closeInstance: Isolate an instance;
    cleanInstance: Clear an instance;
    startInstance: Dis-isolate an instance;
    deleteInstance: Delete an instance;
    setPassword: Set password for an instance;
    importRdb: Import Rdb;
    exportBackup: Export backup;
    restoreBackup: Restore an instance;
    restoreStream: Roll back an instance (cluster instances can be rolled back to any time point within the last three days, but the data for the last 10 minutes cannot be rolled back);
    backupInstance: Back up an instance
    redisName String Instance name
    redisId String Instance ID
    projectId Int ID of project to which the instance belongs
    status Int Task status. 0: To be executed; 1: Executing; 2: Succeeded; 3: Failed; -1: Execution Error
    progress Int Task execution progress. 0: Uncompleted; 1: Completed

    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

    5. Example

    https://redis.api.qcloud.com/v2/index.php?Action=GetRedisTaskList
    &limit=10
    &offset=0
    &beginTime=2016-12-28 00:03:52
    &endTime=2017-02-11 00:03:52
    &redisId=crs-izbob1wh
    &redisName=for API test&taskStatus.0=2
    &taskType.0=task_restoreBackup
    &taskType.1=task_backupInstance
    &taskType.2=task_cleanInstance
    

    The returned results are as below:

    {
        "code": 0,
        "message": "",
        "codeDesc": "Success",
        "totalCount": 9,
        "data": {
            "redisTaskSet": [
                {
                    "startTime": "2017-02-10 16:56:18",
                    "taskName": "restoreBackup",
                    "redisName": "for API test",
                    "redisId": "crs-izbob1wh",
                    "projectId": 0,
                    "status": 2,
                    "progress": 1
                },
                {
                    "startTime": "2017-02-10 15:02:36",
                    "taskName": "backupInstance",
                    "redisName": "for API test",
                    "redisId": "crs-izbob1wh",
                    "projectId": 0,
                    "status": 2,
                    "progress": 1
                },
                {
                    "startTime": "2017-02-10 14:59:29",
                    "taskName": "backupInstance",
                    "redisName": "for API test",
                    "redisId": "crs-izbob1wh",
                    "projectId": 0,
                    "status": 2,
                    "progress": 1
                },
                {
                    "startTime": "2017-02-09 19:00:24",
                    "taskName": "backupInstance",
                    "redisName": "for API test",
                    "redisId": "crs-izbob1wh",
                    "projectId": 0,
                    "status": 2,
                    "progress": 1
                },
                {
                    "startTime": "2017-02-08 19:09:26",
                    "taskName": "backupInstance",
                    "redisName": "for API test",
                    "redisId": "crs-izbob1wh",
                    "projectId": 0,
                    "status": 2,
                    "progress": 1
                },
                {
                    "startTime": "2017-02-08 17:21:32",
                    "taskName": "restoreBackup",
                    "redisName": "for API test",
                    "redisId": "crs-izbob1wh",
                    "projectId": 0,
                    "status": 2,
                    "progress": 1
                },
                {
                    "startTime": "2017-02-08 16:46:34",
                    "taskName": "backupInstance",
                    "redisName": "for API test",
                    "redisId": "crs-izbob1wh",
                    "projectId": 0,
                    "status": 2,
                    "progress": 1
                },
                {
                    "startTime": "2017-02-08 15:38:16",
                    "taskName": "cleanInstance",
                    "redisName": "for API test",
                    "redisId": "crs-izbob1wh",
                    "projectId": 0,
                    "status": 2,
                    "progress": 1
                },
                {
                    "startTime": "2017-02-08 15:35:25",
                    "taskName": "backupInstance",
                    "redisName": "for API test",
                    "redisId": "crs-izbob1wh",
                    "projectId": 0,
                    "status": 2,
                    "progress": 1
                }
            ]
        }
    }
    

    Was this page helpful?

    Was this page helpful?

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