Help & DocumentationTencentDB for RedisAPI DocumentationInstance APIsDescribeTaskInfo

DescribeTaskInfo

Last updated: 2020-03-20 17:05:46

PDF

1. API Description

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

This API is used to query a task result.

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

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: DescribeTaskInfo.
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.
TaskId Yes Integer Task ID

3. Output Parameters

Parameter Name Type Description
Status String Task status. preparing: to be run; running: running; succeed: succeeded; failed: failed; error: running error.
StartTime String Task start time
TaskType String Task type
InstanceId String Instance ID
TaskMessage String Task message, which is displayed in case of an error. It will be blank if the status is running or succeeded
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Request Sample

Input Example

https://redis.tencentcloudapi.com/?Action=DescribeTaskInfo
&TaskId=18215
&<Common request parameter>

Output Example

{
  "Response": {
    "Status": "succeed",
    "StartTime": "2018-11-01 17:25:14",
    "TaskType": "Redis cache purge process",
    "InstanceId": "crs-09u2u96z",
    "TaskMessage": "",
    "RequestId": "81120ab8-fea0-41ab-af7e-283c0348c4fc"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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.InvalidParameter Invalid service parameter.
InvalidParameter.PermissionDenied The API has no CAM permissions.