Queries for batch information from the execution history of scheduled tasks and returns aggregated results.
Operation description
This API uses a centralized endpoint. You can call this API only from the China (Shanghai) or Singapore (Singapore) regions.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
No |
The region ID.
|
cn-shanghai |
| TimerType |
string |
No |
The type of the scheduled task. This operation returns batch information for timer-based scheduled tasks only.
|
1 |
| MaxResults |
string |
No |
The maximum number of entries to return. |
20 |
| NextToken |
string |
No |
The token used to retrieve the next page of results. Set this parameter to the |
caeba0bbb2be03f84eb48b699f0a4883 |
| SearchRegionId |
string |
No |
The ID of the region where the cloud computers are located. This parameter filters the results to include only cloud computers in the specified region. |
cn-hangzhou |
| GroupId |
string |
No |
The ID of the scheduled task group. |
ccg-i1ruuudp92qpj**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response schema. |
||
| RequestId |
string |
The ID of the request. |
E54EB497-D7B7-5F04-B744-D8DFA7B****** |
| Count |
integer |
The total number of entries. |
1 |
| NextToken |
string |
The token to use to retrieve the next page of results. This parameter is returned only when more results are available. |
caeba0bbb2be03f84eb48b699f0a4883 |
| Results |
array<object> |
A list of batches. |
|
|
object |
The details of a batch. |
||
| BatchId |
string |
The ID of the batch. |
ccg-0cvfvf6u1enx1**** |
| TimerType |
string |
The type of the scheduled task. |
TimerBoot |
| CreateTime |
string |
The time when the batch was created. |
2023-08-03T08:27:29Z |
| SucceedCount |
integer |
The number of successfully executed tasks. |
0 |
| FailedCount |
integer |
The number of failed tasks. |
0 |
| SkippedCount |
integer |
The number of skipped tasks. |
0 |
| RunningCount |
integer |
The number of running tasks. |
0 |
Examples
Success response
JSON format
{
"RequestId": "E54EB497-D7B7-5F04-B744-D8DFA7B******",
"Count": 1,
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
"Results": [
{
"BatchId": "ccg-0cvfvf6u1enx1****",
"TimerType": "TimerBoot",
"CreateTime": "2023-08-03T08:27:29Z",
"SucceedCount": 0,
"FailedCount": 0,
"SkippedCount": 0,
"RunningCount": 0
}
]
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.