ModifyScheduledTask_弹性伸缩_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

定时任务支持两种伸缩方式:

  • 通过ScheduledAction参数设置需要执行的伸缩规则。
  • 通过ScalingGroupId参数设置伸缩组内实例数量。
说明 不支持同时设置ScheduledActionScalingGroupId

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
ess:ModifyScheduledTask
Update
ScalingGroup
acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

请求参数

字段名称字段详情
ScheduledTaskIdstring

定时任务的 ID。

示例值:edRtShc57WGXdt8TlPbr****参考取值来源:
    CreateScheduledTask
    DescribeScheduledTasks
ScheduledTaskNamestring

定时任务的名称。2-64 个字符,以大小写字母、数字或中文开头,可包含(.)、下划线(_)或中划线(-)。同一账号同一地域内唯一。

示例值:scheduled****参考取值来源:
    DescribeScheduledTasks
Descriptionstring

定时任务的描述信息。2-200 个字符。

示例值:Test scheduled task.
ScheduledActionstring

如果伸缩方式为选择已有伸缩规则时,才会出现该配置项,请您选择已创建的伸缩规则,填写伸缩规则的唯一标识符,可在伸缩规则详情页查看。展开详情

示例值:ari:acs:ess:cn-hangzhou:14069264****:scalingrule/asr-bp12tcnol686y1ik****参考取值来源:
    DescribeScheduledTasks
RecurrenceEndTimestring

重复执行定时任务的结束时间。按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为:YYYY-MM-DDThh:mmZ。不能填写自修改当天起 365 日后的时间。

示例值:2014-08-20T16:55Z
LaunchTimestring

定时任务执行的时间点。按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为:YYYY-MM-DDThh:mmZ。不能填写自修改当天起 90 日后的时间。展开详情

示例值:2014-08-18T10:52Z
RecurrenceTypestring

设置定时任务重复的周期类型,支持按日、周、月等周期性执行。取值范围:展开详情

示例值:Daily
RecurrenceValuestring

定时任务重复执行的周期类型对应数值。展开详情

示例值:2
TaskEnabledboolean

是否启动定时任务。取值范围:展开详情

示例值:true
LaunchExpirationTimeinteger<int32>

定时任务触发操作失败后,弹性伸缩将在重试过期时间内继续尝试执行定时任务。单位为秒,取值范围:0~1800。展开详情

示例值:600取值 <= 86400
MinValueinteger<int32>

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

示例值:0
MaxValueinteger<int32>

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

示例值:10
DesiredCapacityinteger<int32>

定时任务的伸缩方式为设置伸缩组内实例数量时,指定伸缩组内实例的期望实例数。展开详情

示例值:10
ScalingGroupIdstring

如果伸缩方式为设置伸缩组内实例数量,才会出现该配置项,请您填写定时任务触发时需要修改实例数量的伸缩组 ID。指定ScalingGroupId后,您需要为MinValueMaxValueDesiredCapacity中至少一个参数指定数量。展开详情

示例值:asg-bp18p2yfxow2dloq****参考取值来源:
    ApplyScalingGroup
    CreateScalingGroup
    DescribeScalingGroups
    AttachServerGroups
    DetachServerGroups
RegionIdstring

地域 ID。

示例值:cn-hangzhou参考取值来源:
    DescribeRegions

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
Throttling
Request was denied due to request throttling.诊断

变更历史

变更时间变更内容概要操作
2024-12-17
新增请求参数RegionId
2022-09-09
新增OpenAPI,修改一个定时任务的信息

相关示例