Query scheduled tasks using DescribeScheduledTasks - Auto Scaling - Alibaba Cloud - Auto Scaling

Queries scheduled tasks, including details such as execution time, scaling group ID, recurrence settings, and the total number of tasks.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ess:DescribeScheduledTasks

get

*ScalingGroup

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

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 that the scheduled tasks execute when triggered.
	string	No	The scaling rule that the scheduled task executes when triggered. 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****
TaskName	string	No	The name of the scheduled task. Supports fuzzy keyword search.	scheduled****
RecurrenceType	string	No	The recurrence type of the scheduled task. Valid values: Daily: The scheduled task runs once every specified number of days. Weekly: The scheduled task runs on each specified day of the week. Monthly: The scheduled task runs on each specified day of the month. Cron: The scheduled task runs based on the specified cron expression.	Weekly
RecurrenceValue	string	No	The recurrence value of the scheduled task. You can specify this parameter only if you set RecurrenceType to Weekly. Separate multiple values with commas (,). The values that correspond to Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday are 0, 1, 2, 3, 4, 5, and 6.	1,2,3
TaskEnabled	boolean	No	Whether the scheduled task is enabled. true false	true

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	50
TotalCount	integer	The total number of scheduled tasks.	1
ScheduledTasks	array<object>	The scheduled tasks.
	object	Details of the scheduled tasks.
TaskEnabled	boolean	Indicates whether the scheduled task is enabled. true false Default value: true.	true
RecurrenceValue	string	The recurrence frequency of the scheduled task.	1
RecurrenceType	string	The recurrence type of the scheduled task.	Daily
MaxValue	integer	The maximum number of instances in the scaling group. This parameter takes effect only when `Scaling Method` is set to `Configure Number of Instances in Scaling Group`.	10
ScheduledTaskName	string	The name of the scheduled task.	scheduled****
RecurrenceEndTime	string	The end time of the scheduled task recurrence.	2014-08-20T16:55Z
DesiredCapacity	integer	The desired number of instances in the scaling group. This parameter takes effect only when `Scaling Method` is set to `Configure Number of Instances in Scaling Group`.	10
ScheduledTaskId	string	The ID of the scheduled task.	edRtShc57WGXdt8TlPbr****
MinValue	integer	The minimum number of instances in the scaling group. This parameter takes effect only when `Scaling Method` is set to `Configure Number of Instances in Scaling Group`.	0
ScalingGroupId	string	The ID of the scaling group to which the scheduled task belongs.	asg-bp1bo5tca4m56nap****
LaunchExpirationTime	integer	The time window during which the scheduled task can be retried. Unit: seconds. Valid values: 0 to 21600. If the task is not executed at the scheduled time, Auto Scaling retries the task within the specified time window.	600
Description	string	The description of the scheduled task.	Test scheduled task.
ScheduledAction	string	The scaling rule of the scheduled task. Returned only when ScheduledActions is specified in the request.	ari:acs:ess:cn-hangzhou:1406926474**:scalingrule/asr-bp1id5rhu8edp7kd**
LaunchTime	string	The time at which the scheduled task is triggered.	2014-08-18T10:52Z

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.