DescribeScheduledTasks - 查询定时任务的信息 - 弹性伸缩

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

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ess:DescribeScheduledTasks

get

*ScalingGroup

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	定时任务所属伸缩组的地域 ID。	cn-qingdao
PageNumber	integer	否	定时任务列表的页码，起始值：1。默认值：1。	1
PageSize	integer	否	分页查询时设置的每页行数，最大值：50。默认值：10。	50
ScalingGroupId	string	否	执行定时任务的伸缩组的 ID。	asg-bp1bo5tca4m56nap****
ScheduledActions	array	否	仅当定时任务指定了伸缩规则时，定时任务触发时使用的伸缩规则。
	string	否	仅当定时任务指定了伸缩规则时，定时任务触发时使用的伸缩规则。取值为伸缩规则的唯一标识符（ScalingRuleAri）。	ari:acs:ess:cn-hangzhou:1406926474**:scalingrule/asr-bp1id5rhu8edp7kd**
ScheduledTaskIds	array	否	待查询定时任务的 ID。
	string	否	待查询定时任务的 ID。	edRtShc57WGXdt8TlPbr****
ScheduledTaskNames	array	否	待查询定时任务的名称。
	string	否	待查询定时任务的名称。	scheduled****
TaskName	string	否	任务名称，支持根据关键字模糊搜索。	scheduled****
RecurrenceType	string	否	重复执行定时任务的类型，取值范围： Daily：每多少天重复执行一次定时任务。 Weekly：每周指定几天重复执行一次定时任务。 Monthly：每月内指定几天重复执行一次定时任务。 Cron：按照指定的 Cron 表达式执行定时任务。	Weekly
RecurrenceValue	string	否	重复执行定时任务的数值。仅支持当 RecurrenceType 为 Weekly 时指定此字段，可以填入多个值，填多个值时使用半角逗号（,）分隔。例如，周日、周一、周二、周三、周四、周五、周六的值依次为：0,1,2,3,4,5,6。	1,2,3
TaskEnabled	boolean	否	定时任务是否已启动。 true：任务已启动。 false：任务已停止。	true

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageNumber	integer	当前页码。	1
PageSize	integer	每页行数。	50
TotalCount	integer	定时任务总数。	1
ScheduledTasks	array<object>	定时任务信息组成的集合。
	object	定时任务信息组成的集合。
TaskEnabled	boolean	是否启动定时任务。 true：启动任务。 false：停止任务。默认值：true。	true
RecurrenceValue	string	重复触发定时任务的数值。	1
RecurrenceType	string	重复触发定时任务的类型。	Daily
MaxValue	integer	定时任务的`伸缩方式`选择`伸缩组内实例数量设置`时，指定伸缩组内实例的最大数量。	10
ScheduledTaskName	string	定时任务的名称。	scheduled****
RecurrenceEndTime	string	重复触发定时任务的结束时间。	2014-08-20T16:55Z
DesiredCapacity	integer	定时任务的`伸缩方式`选择`伸缩组内实例数量设置`时，指定伸缩组内实例的期望实例数。	10
ScheduledTaskId	string	定时任务的 ID。	edRtShc57WGXdt8TlPbr****
MinValue	integer	定时任务的`伸缩方式`选择`伸缩组内实例数量设置`时，指定伸缩组内实例的最小数量。	0
ScalingGroupId	string	执行定时任务的伸缩组的 ID。	asg-bp1bo5tca4m56nap****
LaunchExpirationTime	integer	定时任务触发操作失败后，在此时间内重试。单位为秒，取值范围：0~21600。	600
Description	string	定时任务的描述信息。	Test scheduled task.
ScheduledAction	string	执行定时任务时使用的伸缩规则。仅当定时任务指定了伸缩规则时，返回该参数。	ari:acs:ess:cn-hangzhou:1406926474**:scalingrule/asr-bp1id5rhu8edp7kd**
LaunchTime	string	定时任务触发的时间点。	2014-08-18T10:52Z

示例

正常返回示例

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"
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。