Domain name for API request: mps.tencentcloudapi.com.
ScrollToken
parameter to query tasks with multiple calls.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: DescribeTasks. |
Version | Yes | String | Common Params. The value used for this API: 2019-06-12. |
Region | No | String | Common Params. This parameter is not required for this API. |
Status | Yes | String | Filter: Task status. Valid values: WAITING (waiting), PROCESSING (processing), FINISH (completed). |
Limit | No | Integer | Number of returned entries. Default value: 10. Maximum value: 100. |
ScrollToken | No | String | Scrolling identifier which is used for pulling in batches. If a single request cannot pull all the data entries, the API will return ScrollToken , and if the next request carries it, the next pull will start from the next entry. |
Parameter Name | Type | Description |
---|---|---|
TaskSet | Array of TaskSimpleInfo | Task overview list. |
ScrollToken | String | Scrolling identifier. If a request does not return all the data entries, this field indicates the ID of the next entry. If this field is an empty string, there is no more data. |
TotalCount | Integer | The total number of records that meet the conditions. |
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. |
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTasks
<Common request parameters>
{
"Status": "FINISH",
"Limit": "5"
}
{
"Response": {
"TotalCount": 12,
"TaskSet": [
{
"TaskId": "taskId1",
"TaskType": "WorkflowTask",
"SubTaskTypes": [
"action-trans"
],
"CreateTime": "2018-12-27T13:57:15Z",
"BeginProcessTime": "2018-12-27T13:57:15Z",
"FinishTime": "2018-12-27T13:57:15Z"
},
{
"TaskId": "taskId2",
"TaskType": "WorkflowTask",
"SubTaskTypes": [
"action-trans"
],
"CreateTime": "2018-12-27T13:57:15Z",
"BeginProcessTime": "2018-12-27T13:57:15Z",
"FinishTime": "2018-12-27T13:57:15Z"
},
{
"TaskId": "taskId3",
"TaskType": "WorkflowTask",
"SubTaskTypes": [
"action-trans"
],
"CreateTime": "2018-12-27T13:57:15Z",
"BeginProcessTime": "2018-12-27T13:57:15Z",
"FinishTime": "2018-12-27T13:57:15Z"
},
{
"TaskId": "taskId4",
"TaskType": "WorkflowTask",
"SubTaskTypes": [
"action-trans"
],
"CreateTime": "2018-12-27T13:57:15Z",
"BeginProcessTime": "2018-12-27T13:57:15Z",
"FinishTime": "2018-12-27T13:57:15Z"
},
{
"TaskId": "taskId5",
"TaskType": "WorkflowTask",
"SubTaskTypes": [
"action-trans"
],
"CreateTime": "2018-12-27T13:57:15Z",
"BeginProcessTime": "2018-12-27T13:57:15Z",
"FinishTime": "2018-12-27T13:57:15Z"
}
],
"ScrollToken": "taskId6",
"RequestId": "46311b39-10ce-47eb-b2b6-7ce82bb4476d"
}
}
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTasks
<Common request parameters>
{
"Status": "FINISH",
"ScrollToken": "taskId6",
"Limit": "5"
}
{
"Response": {
"TotalCount": 1,
"TaskSet": [
{
"TaskId": "taskId7",
"TaskType": "WorkflowTask",
"SubTaskTypes": [
"action-trans"
],
"CreateTime": "2018-12-27T13:57:15Z",
"BeginProcessTime": "2018-12-27T13:57:15Z",
"FinishTime": "0000-00-00T00:00:00Z"
}
],
"ScrollToken": "",
"RequestId": "46311b39-10ce-47eb-b2b6-7ce82bb4476d"
}
}
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTasks
<Common request parameters>
{
"Status": "PROCESSING",
"Limit": "5"
}
{
"Response": {
"TotalCount": 1,
"TaskSet": [
{
"TaskId": "taskId6",
"TaskType": "WorkflowTask",
"SubTaskTypes": [
"action-trans"
],
"CreateTime": "2018-12-27T13:57:15Z",
"BeginProcessTime": "2018-12-27T13:57:15Z",
"FinishTime": "2018-12-27T13:57:15Z"
}
],
"ScrollToken": "",
"RequestId": "46311b39-10ce-47eb-b2b6-7ce82bb4476d"
}
}
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 |
---|---|
FailedOperation.InvalidMpsUser | Operation failed: unauthorized MPS user. |
InternalError | Internal error. |
InvalidParameterValue | Incorrect parameter value. |
InvalidParameterValue.Limit | Parameter error: Limit. |
Was this page helpful?