DescribeTasks

Last updated: 2020-07-24 14:33:49

1. API Description

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

This API is used to query the task list.

A maximum of 20 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: DescribeTasks.
Version Yes String Common parameter. The value used for this API: 2019-08-23.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product. This API only supports: ap-hongkong, ap-seoul, ap-shanghai, ap-singapore, ap-taipei, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley
ClusterIds.N No Array of String List of IDs of clusters where the tasks to be queried reside
TaskIds.N No Array of String List of IDs of tasks to be queried
Filters.N No Array of Filter Filter. Valid values: Content, TaskType, Operator, Time
Offset No Integer Query list offset
Limit No Integer Number of returned results in query list

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of tasks
TaskInfos Array of TaskInfoNew List of details of queried tasks
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying task list

This example shows you how to query task details by specifying task IDs.

Input Example

https://tcaplus.tencentcloudapi.com/?Action=DescribeTasks
&ClusterIds.0=5674209986
&Offset=3
&Limit=3
&<common request parameters>

Output Example

{
  "Response": {
    "RequestId": "72fc70ce-2396-4b8e-ac54-9bce72058da1",
    "TaskInfos": [
      {
        "ClusterName": "gz test PROTO",
        "ClusterId": "5674209986",
        "Content": "20548499 modify quotas table(tb_example) of Cluster(5674209986) TableGroup(101), InstanceId tcaplus-1f224454, Storage Layer Expand: volume[1 -> 2], owner 20548499",
        "Operator": "20548499",
        "Progress": 0,
        "StartTime": "2019-08-30 18:16:50",
        "TaskId": "5674209986-1202",
        "TaskType": "ModifyTableQuotas",
        "TransId": "0",
        "UpdateTime": "2019-08-30 18:16:50"
      },
      {
        "ClusterName": "gz test PROTO",
        "ClusterId": "5674209986",
        "Content": "20548499 modify table(tb_example)'s structure of Cluster(5674209986) TableGroup(101), InstanceId tcaplus-1f224454, owner 20548499",
        "Operator": "20548499",
        "Progress": 100,
        "StartTime": "2019-08-30 18:02:50",
        "TaskId": "5674209986-1200",
        "TaskType": "ModifyTables",
        "TransId": "558",
        "UpdateTime": "2019-08-30 18:02:51"
      },
      {
        "ClusterName": "gz test PROTO",
        "ClusterId": "5674209986",
        "Content": "20548499 clear table(tb_example) of Cluster(5674209986) TableGroup(101), InstanceId tcaplus-1f224454, owner 20548499",
        "Operator": "20548499",
        "Progress": 0,
        "StartTime": "2019-08-30 17:34:07",
        "TaskId": "5674209986-1199",
        "TaskType": "ClearTables",
        "TransId": "557",
        "UpdateTime": "2019-08-30 17:34:07"
      }
    ],
    "TotalCount": 19
  }
}

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
InternalError Internal error.
InvalidParameterValue Incorrect parameter value.

Was this page helpful?

Was this page helpful?

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