Help & DocumentationAPIsTencentDB for RedisInstance APIsDescribeTaskInfo

DescribeTaskInfo

Last updated: 2019-09-09 12:20:55

Contents：

1. API Description

API domain name: redis.tencentcloudapi.com.

This API queries task result.

Default API request rate limit: 20 requests/sec.

Note: This API supports financial availability zones. Because financial availability zones and non-financial availability zones are isolated, if the common parameter Region specifies a financial availability zone (e.g., ap-shanghai-fsi), you need to specify a domain name with the financial availability zone as well, which preferably in the same region as the specified Region, for example: vod.ap-shanghai-fsi.tencentcloudapi.com.

2. Input Parameters

The following parameters are required for requesting this API, including action-specific parameters and common parameters. For more information about common parameters for all requests, see Common Request Parameters.

Parameter name Required Type Description
Action Yes String Common parameter; the name of this API: DescribeTaskInfo
Version Yes String Common parameter; the version of this API: 2018-04-12
Region Yes String Common parameters; for details, 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: error running
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 is blank if the status is running or succeeded
RequestId String The ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Sample

Sample 1. Request Example

Input Sample Code

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

Output Sample Code

{
  "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

API Explorer is a tool that provides ease of use in requesting APIs, authenticating identities, generating SDK and exploring APIs in Tencent Cloud environment.

SDK

TencentCloud API 3.0 integrates software development toolkits (SDKs) that support various programming languages to make it easier for you to call the APIs.

TCCLI

6. Error Codes

The following error codes are API business logic-related. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.SystemError Internal system error, irrelevant to the business.
InvalidParameter.InvalidParameter Application parameter error.
InvalidParameter.PermissionDenied The API has no CAM permissions.