Domain name for API request: cfg.tencentcloudapi.com.
This API is used to query the task list.
A maximum of 100 requests can be initiated per second for this API.
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 Params. The value used for this API: DescribeTaskList. |
Version | Yes | String | Common Params. The value used for this API: 2021-08-20. |
Region | No | String | Common Params. This parameter is not required. |
Limit | Yes | Integer | Pagination limit |
Offset | Yes | Integer | Pagination offset |
TaskTitle | No | String | Experiment name |
TaskTag.N | No | Array of String | Tag key |
TaskStatus | No | Integer | Task status (1001: not started; 1002: in progress; 1003: paused; 1004: ended) |
TaskStartTime | No | String | Start time, in fixed format: %Y-%m-%d %H:%M:%S |
TaskEndTime | No | String | End time, in fixed format: %Y-%m-%d %H:%M:%S |
TaskUpdateTime | No | String | Update time, in fixed format: %Y-%m-%d %H:%M:%S |
Tags.N | No | Array of TagWithDescribe | Tag pair |
Filters.N | No | Array of ActionFilter | Filtering criteria |
TaskId.N | No | Array of Integer | Experiment ID |
ApplicationId.N | No | Array of String | ID of the associated application for filtering |
ApplicationName.N | No | Array of String | Associated application for filtering |
TaskStatusList.N | No | Array of Integer | Task status for filtering, supporting multiple states (1001: not started; 1002: in progress; 1003: paused; 1004: ended) |
Parameter Name | Type | Description |
---|---|---|
TaskList | Array of TaskListItem | None |
Total | Integer | Number of tables in the list |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to query the experiment list.
POST / HTTP/1.1
Host: cfg.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTaskList
<Common request parameters>
{
"Limit": "10",
"TaskTag": [
"Feiyang"
],
"Offset": "0"
}
{
"Response": {
"RequestId": "47e12dca-fa37-49b4-86e1-d7d3d7674640",
"TaskList": [
{
"TaskId": 2,
"TaskTitle": "Guangzhou zone 2 - shut down",
"TaskDescription": "Guangzhou zone 1 - shut down",
"TaskTag": "Feiyang",
"TaskStatus": 1002,
"TaskCreateTime": "2021-08-14 00:37:34",
"TaskUpdateTime": "2021-09-18 19:18:28",
"TaskPreCheckStatus": 0,
"TaskPreCheckSuccess": false
}
],
"Total": 1
}
}
This example shows you how to
query the experiment list (including pre-check status information).
POST / HTTP/1.1
Host: cfg.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTaskList
<Common request parameters>
{
"Limit": "2",
"Offset": "0"
}
{
"Response": {
"RequestId": "597dbef8-fcf3-46c2-9561-f87694052606",
"TaskList": [
{
"TaskId": 3077,
"TaskTitle": "Experiment pre-check test",
"TaskDescription": "Experiment pre-check test",
"TaskTag": "",
"TaskStatus": 1001,
"TaskCreateTime": "2022-09-19 12:57:22",
"TaskUpdateTime": "2022-09-19 12:57:22",
"TaskPreCheckStatus": 2,
"TaskPreCheckSuccess": false
},
{
"TaskId": 3076,
"TaskTitle": "[Public cloud] Mongo node fault",
"TaskDescription": "[Public cloud] Mongo node fault",
"TaskTag": "",
"TaskStatus": 1003,
"TaskCreateTime": "2022-09-19 11:09:50",
"TaskUpdateTime": "2022-09-19 12:17:49",
"TaskPreCheckStatus": 0,
"TaskPreCheckSuccess": false
}
],
"Total": 2450
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
InvalidParameter | Parameter error. |
InvalidParameterValue | Parameter value error. |
MissingParameter | Parameters are missing |
UnknownParameter | Unknown parameter. |
UnsupportedOperation | The operation is not supported. |
Was this page helpful?