全部產品
Search
文件中心

Auto Scaling:ModifyScheduledTask

更新時間:Jan 14, 2025

如果當前伸縮組的定時任務不能滿足業務需求,您可以調用ModifyScheduledTask介面,通過指定定時任務的ID修改已有定時任務的配置參數:需要執行的伸縮規則、伸縮組內執行個體數量、任務執行頻率、重試策略等。

介面說明

定時任務支援兩種伸縮方式:

  • 通過ScheduledAction參數設定需要執行的伸縮規則。
  • 通過ScalingGroupId參數設定伸縮組內執行個體數量。
說明 不支援同時設定ScheduledActionScalingGroupId

調試

您可以在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****

如果伸縮方式為選擇已有伸縮規則時,才會出現該配置項,請您選擇已建立的伸縮規則,填寫伸縮規則的唯一識別碼,可在伸縮規則詳情頁查看。

說明 不支援同時設定ScheduledActionScalingGroupId
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,則此屬性指定的時間點,預設為迴圈執行的時間點。
  • 如果未指定RecurrenceType,則按指定的日期和時間執行一次。
RecurrenceType String Daily

定時任務重複執行的周期類型,支援按日、周、月等周期性執行。取值範圍:

  • Daily:每多少天重複執行一次定時任務。
  • Weekly:每周指定幾天重複執行一次定時任務。
  • Monthly:每月內指定幾天重複執行一次定時任務。
  • Cron:按照指定的Cron運算式執行定時任務。

修改後,RecurrenceTypeRecurrenceValue需要同時有效。

RecurrenceValue String 2

定時任務重複執行的周期類型對應數值。

  • RecurrenceType取值為Daily時,只能填一個值,取值範圍:1~31。
  • RecurrenceType取值為Weekly時,可以填入多個值,填多個值時使用半形逗號(,)分隔。例如,周日、周一、周二、周三、周四、周五、周六的值依次為:0,1,2,3,4,5,6
  • RecurrenceType取值為Monthly時,格式為A-B。A、B的取值範圍為1~31,並且B必須大於等於A。
  • RecurrenceType取值為Cron時,表示UTC時間,支援分、時、日、月、星期的五個域運算式,支援萬用字元半形逗號(,)、半形問號(?)、短劃線(-)、星號(*)、井號(#)、正斜線(/)、L和W。

修改後,RecurrenceTypeRecurrenceValue需要同時有效。

TaskEnabled Boolean true

是否啟動定時任務。取值範圍:

  • true:啟動定時任務。
  • false:停止定時任務。

預設值:true。

LaunchExpirationTime Integer 600

定時任務觸發操作失敗後,Auto Scaling將在重試到期時間內繼續嘗試執行定時任務。單位為秒,取值範圍:0~1800。

預設值:600。

MinValue Integer 0

定時任務的伸縮方式為設定伸縮組內執行個體數量時,指定伸縮組內執行個體的最小數量。

MaxValue Integer 10

定時任務的伸縮方式為設定伸縮組內執行個體數量時,指定伸縮組內執行個體的最大數量。

DesiredCapacity Integer 10

定時任務的伸縮方式為設定伸縮組內執行個體數量時,指定伸縮組內執行個體的期望執行個體數。

說明 伸縮組必須支援設定期望執行個體數,即在建立該伸縮組時指定了DesiredCapacity
ScalingGroupId String asg-bp18p2yfxow2dloq****

如果伸縮方式為設定伸縮組內執行個體數量,才會出現該配置項,請您填寫定時任務觸發時需要修改執行個體數量的伸縮組ID。指定ScalingGroupId後,您需要為MinValueMaxValueDesiredCapacity中至少一個參數指定數量。

說明 不支援同時設定ScheduledActionScalingGroupId
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與定時任務所在的地區不匹配。