Queries the details of all scheduled tasks.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
polardb:DescribeScheduleTasks | get |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
Status | string | No | The state of the tasks that you want to query. Valid values:
Note
If you do not specify this parameter, all scheduled tasks in all states are queried.
| finish |
DBClusterId | string | No | The cluster ID. Note
| pc-************** |
RegionId | string | No | The ID of the region. Note
| cn-hangzhou |
PageNumber | integer | No | The page number of the page to return. Set this parameter to an integer that is greater than 0. Default value: 1. | 1 |
PageSize | integer | No | The number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30. | 30 |
TaskAction | string | No | The type of scheduled tasks that you want to query. Valid values:
Note
| CreateDBNodes |
DBClusterDescription | string | No | The description of the cluster. | testdb |
OrderId | string | No | The ID of the order. Note
The order ID can contain only digits.
| 20951253014**** |
PlannedStartTime | string | No | The earliest start time of the task that you specified when you created the scheduled task. The time is displayed in UTC. | 2021-01-28T12:00Z |
PlannedEndTime | string | No | The latest start time of the task that you specified when you created the scheduled task. The time is displayed in UTC. | 2021-01-28T12:30Z |
ResourceGroupId | string | No | The ID of the resource group. | rg-************ |
Response parameters
Examples
Sample success responses
JSON
format
{
"Data": {
"PageNumber": 1,
"PageSize": 30,
"TimerInfos": [
{
"Action": "CreateDBNodes",
"CrontabJobId": "86293c29-a03d-4872-b625-***********",
"DBClusterId": "pc-**************",
"DbClusterDescription": "test_cluster",
"DbClusterStatus": "Running",
"OrderId": "208161753******",
"PlannedEndTime": "2021-01-28T12:30Z",
"PlannedFlashingOffTime": "",
"PlannedStartTime": "2021-01-28T12:00Z",
"PlannedTime": "2021-01-28T12:16Z",
"Region": "cn-hangzhou",
"Status": "finish",
"TaskCancel": true,
"TaskId": "53879cdb-9a00-428e-acaf-ff4cff******"
}
],
"TotalRecordCount": 1
},
"Message": "Successful",
"RequestId": "936C7025-27A5-4CB1-BB31-540E1F0CCA12",
"Success": true
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidOrderId.Malformed | The specified parameter OrderId is not valid. | The specified order ID is invalid. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-08-29 | The Error code has changed. The response structure of the API has changed | View Change Details |
2023-09-12 | The Error code has changed | View Change Details |