如果当前伸缩组的定时任务不能满足业务需求,您可以调用ModifyScheduledTask接口,通过指定定时任务的ID修改已有定时任务的配置参数:需要执行的伸缩规则、伸缩组内实例数量、任务执行频率、重试策略等。
接口说明
定时任务支持两种伸缩方式:
- 通过
ScheduledAction
参数设置需要执行的伸缩规则。 - 通过
ScalingGroupId
参数设置伸缩组内实例数量。
ScheduledAction
和ScalingGroupId
。调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | ModifyScheduledTask | 系统规定参数。取值:ModifyScheduledTask。 |
ScheduledTaskId | String | 是 | edRtShc57WGXdt8TlPbr**** | 定时任务的ID。 |
ScheduledTaskName | String | 否 | scheduled**** | 定时任务的名称。2-64个字符,以大小写字母、数字或中文开头,可包含(.)、下划线(_)或中划线(-)。同一账号同一地域内唯一。 |
Description | String | 否 | Test scheduled task. | 定时任务的描述信息。2-200个字符。 |
ScheduledAction | String | 否 | ari:acs:ess:cn-hangzhou:14069264****:scalingrule/asr-bp12tcnol686y1ik**** | 如果伸缩方式为选择已有伸缩规则时,才会出现该配置项,请您选择已创建的伸缩规则,填写伸缩规则的唯一标识符,可在伸缩规则详情页查看。 说明 不支持同时设置 ScheduledAction 和ScalingGroupId 。 |
RecurrenceEndTime | String | 否 | 2014-08-20T16:55Z | 重复执行定时任务的结束时间。按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mmZ。不能填写自修改当天起365日后的时间。 |
LaunchTime | String | 否 | 2014-08-18T10:52Z | 定时任务执行的时间点。按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mmZ。不能填写自修改当天起90日后的时间。
|
RecurrenceType | String | 否 | Daily | 定时任务重复执行的周期类型,支持按日、周、月等周期性执行。取值范围:
修改后, |
RecurrenceValue | String | 否 | 2 | 定时任务重复执行的周期类型对应数值。
修改后, |
TaskEnabled | Boolean | 否 | true | 是否启动定时任务。取值范围:
默认值:true。 |
LaunchExpirationTime | Integer | 否 | 600 | 定时任务触发操作失败后,弹性伸缩将在重试过期时间内继续尝试执行定时任务。单位为秒,取值范围:0~1800。 默认值:600。 |
MinValue | Integer | 否 | 0 | 定时任务的伸缩方式为设置伸缩组内实例数量时,指定伸缩组内实例的最小数量。 |
MaxValue | Integer | 否 | 10 | 定时任务的伸缩方式为设置伸缩组内实例数量时,指定伸缩组内实例的最大数量。 |
DesiredCapacity | Integer | 否 | 10 | 定时任务的伸缩方式为设置伸缩组内实例数量时,指定伸缩组内实例的期望实例数。 说明 伸缩组必须支持设置期望实例数,即在创建该伸缩组时指定了 DesiredCapacity 。 |
ScalingGroupId | String | 否 | asg-bp18p2yfxow2dloq**** | 如果伸缩方式为设置伸缩组内实例数量,才会出现该配置项,请您填写定时任务触发时需要修改实例数量的伸缩组ID。指定 说明 不支持同时设置 ScheduledAction 和ScalingGroupId 。 |
RegionId | String | 否 | cn-hangzhou | 伸缩组所属的地域ID。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** | 请求ID。 |
示例
请求示例
http(s)://ess.aliyuncs.com/?Action=ModifyScheduledTask
&ScheduledTaskId=edRtShc57WGXdt8TlPbr****
&ScheduledTaskName=scheduled****
&Description=Test scheduled task.
&ScheduledAction=ari:acs:ess:cn-hangzhou:14069264****:scalingrule/asr-bp12tcnol686y1ik****
&RecurrenceEndTime=2014-08-20T16:55Z
&LaunchTime=2014-08-18T10:52Z
&RecurrenceType=Daily
&RecurrenceValue=2
&TaskEnabled=true
&LaunchExpirationTime=600
&MinValue=0
&MaxValue=10
&DesiredCapacity=10
&ScalingGroupId=asg-bp18p2yfxow2dloq****
&RegionId=cn-hangzhou
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ModifyScheduledTaskResponse>
<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
</ModifyScheduledTaskResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}
错误码
访问错误中心查看更多错误码。
HttpCode |
错误码 |
错误信息 |
描述 |
404 |
InvalidScheduledTaskId.NotFound |
The specified scheduled task does not exist. |
指定的定时任务在该用户账号下不存在。 |
400 |
InvalidScheduledTaskName.Duplicate |
The specified value of parameter ScheduledTaskName is duplicated. |
定时任务名已存在。 |
400 |
ScheduledAction.RegionMismatch |
The specified scheduled task and the specified scheduled action are not in the same Region. |
指定的ScheduledAction与定时任务所在的地域不匹配。 |