文档

DescribeScheduledTasks

更新时间:

定时任务是一种预设任务,可以在指定时间执行指定的伸缩规则,实现计算资源的自动扩缩容。定时任务创建完成后,您可以调用API DescribeScheduledTasks查询定时任务的详细信息,例如,定时任务的触发时间点、定时任务总数、执行定时任务的伸缩组的ID等。

接口说明

您可以通过定时任务的ID、定时任务的名称、定时任务执行的伸缩规则等查询定时任务。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action String DescribeScheduledTasks

系统规定参数。取值:DescribeScheduledTasks

RegionId String cn-qingdao

定时任务所属伸缩组的地域ID。

PageNumber Integer 1

定时任务列表的页码,起始值:1。

默认值:1。

PageSize Integer 50

分页查询时设置的每页行数,最大值:50。

默认值:10。

ScalingGroupId String asg-bp1bo5tca4m56nap****

执行定时任务的伸缩组的ID。

ScheduledAction.N String ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp1id5rhu8edp7kd****

仅当定时任务指定了伸缩规则时,定时任务触发时使用的伸缩规则。N的取值范围:0~20。

取值为伸缩规则的唯一标识符(ScalingRuleAri)。

ScheduledTaskId.N String edRtShc57WGXdt8TlPbr****

待查询定时任务的ID,N的取值范围:1~20。

ScheduledTaskName.N String scheduled****

待查询定时任务的名称,N的取值范围:1~20。

返回数据

名称

类型

示例值

描述

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

请求ID。

PageNumber Integer 1

当前页码。

PageSize Integer 50

每页行数。

TotalCount Integer 1

定时任务总数。

ScheduledTasks Array of ScheduledTask

定时任务信息组成的集合。

ScheduledTask
TaskEnabled Boolean true

是否启动定时任务。

  • true:启动任务。
  • false:停止任务 。

默认值:true。

RecurrenceValue String 1

重复触发定时任务的数值。

RecurrenceType String Daily

重复触发定时任务的类型。

MaxValue Integer 10

定时任务的伸缩方式选择伸缩组内实例数量设置时,指定伸缩组内实例的最大数量。

ScheduledTaskName String scheduled****

定时任务的名称。

RecurrenceEndTime String 2014-08-20T16:55Z

重复触发定时任务的结束时间。

DesiredCapacity Integer 10

定时任务的伸缩方式选择伸缩组内实例数量设置时,指定伸缩组内实例的期望实例数。

ScheduledTaskId String edRtShc57WGXdt8TlPbr****

定时任务的ID。

MinValue Integer 0

定时任务的伸缩方式选择伸缩组内实例数量设置时,指定伸缩组内实例的最小数量。

ScalingGroupId String asg-bp1bo5tca4m56nap****

执行定时任务的伸缩组的ID。

LaunchExpirationTime Integer 600

定时任务触发操作失败后,在此时间内重试。单位为秒,取值范围:0~21600。

Description String Test scheduled task.

定时任务的描述信息。

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

执行定时任务时使用的伸缩规则。仅当定时任务指定了伸缩规则时,返回该参数。

LaunchTime String 2014-08-18T10:52Z

定时任务触发的时间点。

示例

请求示例

http(s)://ess.aliyuncs.com/?Action=DescribeScheduledTasks
&RegionId=cn-qingdao
&PageNumber=1
&PageSize=50
&ScalingGroupId=asg-bp1bo5tca4m56nap****
&ScheduledAction=["ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp1id5rhu8edp7kd****"]
&ScheduledTaskId=["edRtShc57WGXdt8TlPbr****"]
&ScheduledTaskName=["scheduled****"]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeScheduledTasksResponse>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
    <PageNumber>1</PageNumber>
    <PageSize>50</PageSize>
    <TotalCount>1</TotalCount>
    <ScheduledTasks>
        <TaskEnabled>true</TaskEnabled>
        <RecurrenceValue>1</RecurrenceValue>
        <RecurrenceType>Daily</RecurrenceType>
        <MaxValue>10</MaxValue>
        <ScheduledTaskName>scheduled****</ScheduledTaskName>
        <RecurrenceEndTime>2014-08-20T16:55Z</RecurrenceEndTime>
        <DesiredCapacity>10</DesiredCapacity>
        <ScheduledTaskId>edRtShc57WGXdt8TlPbr****</ScheduledTaskId>
        <MinValue>0</MinValue>
        <ScalingGroupId>asg-bp1bo5tca4m56nap****</ScalingGroupId>
        <LaunchExpirationTime>600</LaunchExpirationTime>
        <Description>Test scheduled task.</Description>
        <ScheduledAction>ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp1id5rhu8edp7kd****</ScheduledAction>
        <LaunchTime>2014-08-18T10:52Z</LaunchTime>
    </ScheduledTasks>
</DescribeScheduledTasksResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "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"
  } ]
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (1)