DescribeTaskList

Prev Next

请输入关键字

Recent Pages

文档

Download PDF

最后更新时间：2021-11-18 10:45:35

下载PDF

1. API Description

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

This API is used to query the list of tasks.

A maximum of 100 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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: DescribeTaskList.
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.
InstanceId	No	String	Instance ID
InstanceName	No	String	Instance name
Limit	No	Integer	Number of entries per page
Offset	No	Integer	Offset, which is an integral multiple of `Limit` (rounded down automatically)
ProjectIds.N	No	Array of Integer	Project ID
TaskTypes.N	No	Array of String	Task type
BeginTime	No	String	Start time
EndTime	No	String	End time
TaskStatus.N	No	Array of Integer	Task status

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of tasks
Tasks	Array of TaskInfoDetail	Task details
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Sample request

Input Example

https://redis.tencentcloudapi.com/?Action=DescribeTaskList
&InstanceId=crs-opcazbrb
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "19a7fb07-8e21-4827-88dd-fee57f38e8cd",
    "Tasks": [
      {
        "EndTime": "2019-11-15 14:25:46",
        "InstanceId": "crs-opcazbrb",
        "InstanceName": "multidbccbugfix11153",
        "Progress": 1,
        "ProjectId": 0,
        "Result": 2,
        "StartTime": "2019-11-15 14:25:37",
        "TaskId": 42372,
        "TaskType": "037"
      },
      {
        "EndTime": "2019-11-15 14:25:25",
        "InstanceId": "crs-opcazbrb",
        "InstanceName": "multidbccbugfix11153",
        "Progress": 1,
        "ProjectId": 0,
        "Result": 2,
        "StartTime": "2019-11-15 14:25:16",
        "TaskId": 42371,
        "TaskType": "037"
      }
    ],
    "TotalCount": 2
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

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.
InternalError.DbOperationFailed	Internal system error with the database operation, which may be update, insert, select, etc.
InternalError.InternalError	Internal error.
InvalidParameter.PermissionDenied	The API has no CAM permissions.

Recent Pages