Query a scheduled task

Last Updated: May 11, 2017

Description

Queries information of a scheduled task.

You can use the ScheduledAction to query the relevant scheduled task.

Request parameters

Name Type Required? Description
Action String Yes Operation interface name, required parameter. Value: DescribeScheduledTasks.
RegionId String Yes Region of the scheduled task.
ScheduledTaskId.N String No ID of the scheduled task. You can enter at most 20 IDs. Invalid scheduled task IDs are not displayed in the query results, and no error is reported.
ScheduledTaskName.N String No Display name of the schedules task. You can enter at most 20 display names. Names of invalid scheduled tasks will be neglected in the query results, and no error is reported.
ScheduledAction.N String No Operations performed when the scheduled task is triggered. You can enter at most 20 operations. Invalid operations are not displayed in the query results, and no error is reported.
PageNumber Integer No Page number of the scheduled task list, starting from 1. The default value is 1.
PageSize Integer No When querying by page, this parameter indicates the number of lines per page. Maximum value: 50; default value: 10.

Return parameters

Name Type Description
TotalCount Integer Total number of scheduled tasks
PageNumber Integer Current page number
PageSize Integer Number of lines per page
ScheduledTasks ScheduledTaskSetType A set of scheduled task information

ScheduledTaskSetType is a set of ScheduledTaskItemTypes:

Name Type Description
ScheduledTask ScheduledTaskItemType Information of the scheduled task

The attributes of the ScheduledTaskItemType are listed below:

Name Type Description
ScheduledTaskId String ID of the scheduled task
ScheduledTaskName String Name of the scheduled task
Description String Description of the scheduled task
ScheduledAction String Operations performed when the scheduled task is triggered
LaunchTime String Time point at which the scheduled task is triggered
LaunchExpirationTime Integer Retry interval for the failed scheduled task
RecurrenceType String Type of the scheduled task to be repeated
RecurrenceValue String Value of the scheduled task to be repeated
RecurrenceEndTime String End time of the scheduled task to be repeated
TaskEnabled Bool Whether to enable the scheduled task

Error code

For errors common to all interfaces, refer to the Client Error Table or Server Error Table.

Example

Request example
  1. http://ess.aliyuncs.com/?Action=DescribeScheduledTasks
  2. &RegionId=cn-qingdao
  3. &ScheduledTaskId.1=edRtShc57WGXdt8TlPbrjsnV
  4. &PageSize=50
  5. &<Public Request Parameters>
Return example

XML format:

  1. <DescribeScheduledTasksResponse>
  2. <RequestId>B9B498DA-E836-45FF-83C7-1930492FDD5A</RequestId>
  3. <TotalCount>1</TotalCount>
  4. <PageNumber>1</PageNumber>
  5. <PageSize>50</PageSize>
  6. <ScheduledTasks>
  7. <ScheduledTask>
  8. <Description/>
  9. <LaunchExpirationTime>600</LaunchExpirationTime>
  10. <LaunchTime>2014-08-18T10:52Z</LaunchTime>
  11. <RecurrenceEndTime>2014-08-20T16:55Z</RecurrenceEndTime>
  12. <RecurrenceType>Daily</RecurrenceType>
  13. <RecurrenceValue>1</RecurrenceValue>
  14. <ScheduledAction>
  15. ari:acs:ess:cn-qingdao:1344371:scalingrule/cCBpdYdQuBe2cUxOdu6piOk
  16. </ScheduledAction>
  17. <ScheduledTaskId>edRtShc57WGXdt8TlPbrjsnV</ScheduledTaskId>
  18. <ScheduledTaskName>edRtShc57WGXdt8TlPbrjsnV</ScheduledTaskName>
  19. <TaskEnabled>true</TaskEnabled>
  20. </ScheduledTask>
  21. </ScheduledTasks>
  22. </DescribeScheduledTasksResponse>

JSON format:

  1. {
  2. "RequestId": "43434132-91C4-4264-8343-681130760A5C",
  3. "TotalCount": 1,
  4. "PageSize": 1,
  5. "PageNumber": 1,
  6. "ScheduledTasks": {
  7. "ScheduledTask": [
  8. {
  9. "TaskEnabled": true,
  10. "ScheduledTaskId": "b27CLSc8T478c2iqHr6fqbF",
  11. "Description": "ditingshigechunqingchunan",
  12. "ScheduledTaskName": "9906a33f-14eb-42b8-8bdb-ee8cdf912706",
  13. "LaunchExpirationTime": 120,
  14. "RecurrenceType": "Daily",
  15. "RecurrenceEndTime": "2014-08-13T19:19Z",
  16. "LaunchTime": "2014-08-12T17:55Z",
  17. "RecurrenceValue": "1",
  18. "ScheduledAction": "ari:acs:ess:cn-qingdao:1344371:scalingrule/qGx9feK1giadmp3XKer94cD"
  19. }
  20. ]
  21. }
  22. }
Thank you! We've received your feedback.