DescribeScheduledTasks - Auto Scaling - Alibaba Cloud Documentation Center

Queries information about scheduled tasks.

Operation description

You can query scheduled tasks by scheduled task ID, scheduled task name, or scaling rule associated with the scheduled task.

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 of the scheduled task list. Minimum value: 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page for a paged query. Maximum value: 50. Default value: 10.	50
ScalingGroupId	string	No	The ID of the scaling group that executes the scheduled task.	asg-bp1bo5tca4m56nap****
ScheduledAction	array	No	The scaling rule used when the scheduled task is triggered. This parameter is returned only when the scheduled task specifies a scaling rule.	ari:acs:ess:cn-hangzhou:1406926474**:scalingrule/asr-bp1id5rhu8edp7kd**
	string	No	The scaling rule used when the scheduled task is triggered. This parameter is returned only when the scheduled task specifies a scaling rule. Valid values of N: 0 to 20. The value is the unique identifier of the scaling rule (ScalingRuleAri).	ari:acs:ess:cn-hangzhou:1406926474**:scalingrule/asr-bp1id5rhu8edp7kd**
ScheduledTaskId	array	No	The ID of the scheduled task to query.	edRtShc57WGXdt8TlPbr****
	string	No	The ID of the scheduled task to query. Valid values of N: 1 to 20.	edRtShc57WGXdt8TlPbr****
ScheduledTaskName	array	No	The name of the scheduled task to query.	scheduled****
	string	No	The name of the scheduled task to query. Valid values of N: 1 to 20.	scheduled****
TaskName	string	No	The task name. Fuzzy match by keyword is supported.	scheduled****
RecurrenceType	string	No	The recurrence type of the scheduled task. Valid values: Daily: The scheduled task is executed every specified number of days. Weekly: The scheduled task is executed on specified days of each week. Monthly: The scheduled task is executed on specified days of each month. Cron: The scheduled task is executed based on a specified cron expression.	Weekly
RecurrenceValue	string	No	The recurrence value of the scheduled task. This parameter is supported only when RecurrenceType is set to Weekly. You can specify multiple values separated by commas (,). For example, the values for Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday are 0, 1, 2, 3, 4, 5, and 6.	1,2,3
TaskEnabled	boolean	No	Specifies whether the scheduled task is enabled. true: The task is enabled. false: The task is disabled.	true

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageNumber	integer	The current page number.	1
PageSize	integer	The number of entries per page.	50
TotalCount	integer	The total number of scheduled tasks.	1
ScheduledTasks	object
ScheduledTask	array<object>	The collection of scheduled task information.
	object	The collection of scheduled task information.
TaskEnabled	boolean	Specifies whether the scheduled task is enabled.	true
RecurrenceValue	string	The number of recurrences of the scheduled task.	1
RecurrenceType	string	The interval at which the scheduled task recurs.	Daily
MaxValue	integer	The maximum number of instances in the scaling group when the Scaling Method parameter of the scheduled task 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 recurrence of the scheduled task.	2014-08-20T16:55Z
DesiredCapacity	integer	The expected number of instances in the scaling group when the Scaling Method parameter of the scheduled task 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 when the Scaling Method parameter of the scheduled task is set to Configure Number of Instances in Scaling Group.	0
ScalingGroupId	string	The ID of the scaling group in which you want to execute the scheduled task.	asg-bp1bo5tca4m56nap****
LaunchExpirationTime	integer	The time period during which the failed scheduled task is retried. Unit: seconds. Valid values: 0 to 21600.	600
Description	string	The description of the scheduled task.	Test scheduled task.
ScheduledAction	string	The scaling rule that you want to use to execute the scheduled task. This parameter is returned only if a scaling rule is specified for the scheduled task.	ari:acs:ess:cn-hangzhou:1406926474**:scalingrule/asr-bp1id5rhu8edp7kd**
LaunchTime	string	The point in time at which the scheduled task is triggered.	2014-08-18T10:52Z

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PageNumber": 1,
  "PageSize": 50,
  "TotalCount": 1,
  "ScheduledTasks": {
    "ScheduledTask": [
      {
        "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.