Queries scheduled tasks. A scheduled task is a predefined task that triggers the automatic execution of a scaling rule at the specified point in time. It ensures an automatic scaling of computing resources to fulfill your business demands at a minimum cost. After you create a scheduled task, you can call the DescribeScheduledTasks operation to query the details of the task, such as the execution time point and the scaling group ID. You can also call this operation to query the total number of existing scheduled tasks.
Operation description
You can query scheduled tasks by scaling rule, task ID, or task name.
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 Resourcesis 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 |
|---|---|---|---|---|
| ess:DescribeScheduledTasks | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID of the scaling group to which the scheduled task belongs. | cn-qingdao |
| PageNumber | integer | No | The page number. Pages start from page 1. Default value: 1. | 1 |
| PageSize | integer | No | The number of entries per page. Maximum value: 50. Default value: 10. | 50 |
| ScalingGroupId | string | No | The ID of the scaling group to which the scheduled task belongs. | asg-bp1bo5tca4m56nap**** |
| ScheduledActions | array | No | The scaling rules of the scheduled tasks. Once the scheduled tasks are triggered, the scaling rules are executed. | |
| string | No | The scaling rule of the scheduled task. Once the scheduled task is triggered, the scaling rule is executed. Set the value to the unique identifier of the scaling rule (ScalingRuleAri). | ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp1id5rhu8edp7kd**** | |
| ScheduledTaskIds | array | No | The IDs of the scheduled tasks that you want to query. | |
| string | No | The ID of the scheduled task that you want to query. | edRtShc57WGXdt8TlPbr**** | |
| ScheduledTaskNames | array | No | The names of the scheduled tasks that you want to query. | |
| string | No | The name of the scheduled task that you want to query. | scheduled**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"PageNumber": 1,
"PageSize": 50,
"TotalCount": 1,
"ScheduledTasks": [
{
"TaskEnabled": true,
"RecurrenceValue": "1",
"RecurrenceType": "Daily",
"MaxValue": 10,
"ScheduledTaskName": "scheduled****",
"RecurrenceEndTime": "2014-08-20T16:55Z",
"DesiredCapacity": 10,
"ScheduledTaskId": "edRtShc57WGXdt8TlPbr****",
"MinValue": 0,
"ScalingGroupId": "asg-bp1bo5tca4m56nap****",
"LaunchExpirationTime": 600,
"Description": "Test scheduled task.",
"ScheduledAction": "ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp1id5rhu8edp7kd****",
"LaunchTime": "2014-08-18T10:52Z"
}
]
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-07-04 | The request parameters of the API has changed | View Change Details |