All Products
Search

This Product

    Auto Scaling:DescribeScheduledTasks

    Document Center

    Auto Scaling:DescribeScheduledTasks

    Last Updated:May 16, 2024

    Queries 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.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID of the scaling group to which the scheduled task belongs.

    		cn-qingdao
    PageNumberintegerNo

    The number of the page to return. Pages start from page 1.

    Default value: 1.

    		1
    PageSizeintegerNo

    The number of entries to return on each page. Valid values: 1 to 50.

    Default value: 10.

    		50
    ScalingGroupIdstringNo

    The ID of the scaling group to which the scheduled task belongs.

    		asg-bp1bo5tca4m56nap****
    ScheduledActionsarrayNo

    The actions that you want Auto Scaling to perform when the scheduled task is triggered.

    stringNo

    The actions that you want Auto Scaling to perform when the scheduled task is triggered. You can specify 1 to 20 values for this parameter.

    		ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp1id5rhu8edp7kd****
    ScheduledTaskIdsarrayNo

    The ID of the scheduled task that you want to query.

    stringNo

    The ID of the scheduled task that you want to query. You can specify 1 to 20 values for this parameter.

    		edRtShc57WGXdt8TlPbr****
    ScheduledTaskNamesarrayNo

    The names of the scheduled tasks that you want to query.

    stringNo

    The names of the scheduled tasks that you want to query. You can specify 1 to 20 values for this parameter.

    		scheduled****

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    PageNumberinteger

    The page number of the returned page.

    		1
    PageSizeinteger

    The number of entries returned per page.

    		50
    TotalCountinteger

    The total number of scheduled tasks.

    		1
    ScheduledTasksobject []

    Details of the scheduled tasks.

    TaskEnabledboolean

    Indicates whether the scheduled task is enabled.

    • true
    • false

    Default value: true.

    		true
    RecurrenceValuestring

    The number of recurrences of the scheduled task.

    		1
    RecurrenceTypestring

    The interval at which the scheduled task is repeated.

    		Daily
    MaxValueinteger

    The maximum number of instances in the scaling group if you specify the ScalingGroupId parameter.

    		10
    ScheduledTaskNamestring

    The name of the scheduled task.

    		scheduled****
    RecurrenceEndTimestring

    The end time of the recurrence of the scheduled task.

    		2014-08-20T16:55Z
    DesiredCapacityinteger

    The expected number of instances in the scaling group if you specify the ScalingGroupId parameter.

    		10
    ScheduledTaskIdstring

    The ID of the scheduled task.

    		edRtShc57WGXdt8TlPbr****
    MinValueinteger

    The minimum number of instances in the scaling group if you specify the ScalingGroupId parameter.

    		0
    ScalingGroupIdstring

    The ID of the scaling group to which the scheduled task belongs.

    		asg-bp1bo5tca4m56nap****
    LaunchExpirationTimeinteger

    The time period during which the failed scheduled task is retried. Unit: seconds. Valid values: 0 to 21600.

    		600
    Descriptionstring

    The description of the scheduled task.

    		Test scheduled task.
    ScheduledActionstring

    The scaling rule that is executed when the scheduled task is triggered. This parameter is returned only after a scaling rule is specified for the scheduled task.

    		ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp1id5rhu8edp7kd****
    LaunchTimestring

    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 timeSummary of changesOperation
    No change history