Query CRS Task Result

Last updated: 2017-12-06 18:03:12

1. API Description

This API (DescribeTaskInfo) is used to query the results of a task.
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. For more information, please see Common Request Parameters. The Action field for this API is DescribeTaskInfo.

Parameter Name Required Type Description
requestId Yes UInt Task ID

3. Output Parameters

Parameter Name Type Description
code Int Common error code; 0: Succeeded; other values: Failed. For more information, please see Common Error Codes on the Error Codes page.
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 of data

Array data is composed as follows:

Parameter Name Type Description
data.status Int Task status. 0: To be executed; 1: Executing, 2: Succeeded; 3: Failed; -1: Execution Error |

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=DescribeTaskInfo
&<common request parameters>
&requestId=11963

The returned results are as below:

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": {
        "status": 2
    }
}