DescribeScheduledTasks - Auto Scaling - Alibaba Cloud Documentation Center

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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

Parameter	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	object []	The information collection of the scheduled tasks.
TaskEnabled	boolean	Indicates whether the scheduled task is enabled. true false Default value: true.	true
RecurrenceValue	string	The frequency of recurrence of the scheduled task.	1
RecurrenceType	string	The recurring interval of the scheduled task.	Daily
MaxValue	integer	The maximum number of instances that must be contained in the scaling group. If you set `Scaling Method` to `Configure Number of Instances in Scaling Group`, you can specify this parameter.	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. If you set `Scaling Method` to `Configure Number of Instances in Scaling Group`, you can specify this parameter.	10
ScheduledTaskId	string	The ID of the scheduled task.	edRtShc57WGXdt8TlPbr****
MinValue	integer	The minimum number of instances that must be contained in the scaling group. If you set `Scaling Method` to `Configure Number of Instances in Scaling Group`, you can specify this parameter.	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.	600
Description	string	The description of the scheduled task.	Test scheduled task.
ScheduledAction	string	The scaling rule of the scheduled task. A value is returned for this parameter only after you specify ScheduledActions.	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

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

No change history