定時任務是一種預設任務,您可以通過調用API CreateScheduledTask創(chuàng)建一個定時任務,在指定時間執(zhí)行指定伸縮規(guī)則,實現計算資源的自動擴張或收縮,來滿足業(yè)務需求的同時又能控制成本。
接口說明
-
由于伸縮組正在發(fā)生伸縮活動或者伸縮組停用等原因,導致定時任務觸發(fā)執(zhí)行伸縮規(guī)則失敗后,在
LaunchExpirationTime
內,定時任務會自動重試觸發(fā),否則放棄本次定時觸發(fā)。 -
如果多個定時任務在相近的時間內觸發(fā)執(zhí)行同一個伸縮組的伸縮規(guī)則,則觸發(fā)的伸縮活動詳情如下:
- 已設置期望實例數的伸縮組:多個定時任務觸發(fā)的伸縮活動屬于并行伸縮活動。例如,相近時間內,執(zhí)行多個定時任務后,伸縮組可同時觸發(fā)多個并行伸縮活動。
- 未設置期望實例數的伸縮組: 最早觸發(fā)的定時任務會先執(zhí)行伸縮活動。由于同一個伸縮組同一時刻內只能有一個伸縮活動,排在后面的定時任務會在
LaunchExpirationTime
內自動重試定時觸發(fā)。如果上一個伸縮活動完成之后,排在后面的定時任務還在LaunchExpirationTime
內重試,則執(zhí)行該定時任務的伸縮規(guī)則并觸發(fā)相應的伸縮活動。
-
定時任務支持以下兩種伸縮方式:
- 通過 ScheduledAction 參數設置需要執(zhí)行的伸縮規(guī)則。
- 通過 ScalingGroupId 參數設置伸縮組內實例數量。
說明 不支持同時設置 ScheduledAction 和 ScalingGroupId。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執(zhí)行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
ess:CreateScheduledTask | create |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 定時任務所屬地域的 ID。 | cn-qingdao |
ScheduledTaskName | string | 否 | 定時任務的名稱。2~64 個英文或中文字符,以數字、大小字母或中文開頭,可包含數字、下劃線(_)、短劃線(-)或半角句號(.)。同一賬號同一地域內唯一。 默認值為 | scheduled**** |
Description | string | 否 | 定時任務的描述信息,長度為 2~200 個英文或中文字符。 | Test scheduled task. |
ScheduledAction | string | 否 | 定時任務觸發(fā)時需要執(zhí)行的伸縮規(guī)則,填寫伸縮規(guī)則的唯一標識符。 指定 | ari:acs:ess:cn-hangzhou:140692647****:scalingrule/asr-bp12tcnol686y1ik**** |
RecurrenceEndTime | string | 否 | 重復執(zhí)行定時任務的結束時間。按照 ISO8601 標準表示,并需要使用 UTC 時間。 格式為:YYYY-MM-DDThh:mmZ。不能填寫自創(chuàng)建當天起 365 日后的時間。 | 2014-08-17T16:55Z |
LaunchTime | string | 否 | 定時任務觸發(fā)的時間點。 按照 ISO8601 標準表示,并需要使用 UTC 時間。格式為:YYYY-MM-DDThh:mmZ。不能填寫自創(chuàng)建當天起 90 日后的時間。
| 2014-08-17T16:52Z |
RecurrenceType | string | 否 | 重復執(zhí)行定時任務的類型,取值范圍:
您需要同時指定 | Daily |
RecurrenceValue | string | 否 | 重復執(zhí)行定時任務的數值。
您需要同時指定 | 1 |
TaskEnabled | boolean | 否 | 是否啟動定時任務。
默認值:true。 | true |
LaunchExpirationTime | integer | 否 | 定時任務觸發(fā)操作失敗后,在此時間內重試。單位為秒,取值范圍:0~1800。 默認值:600。 | 600 |
MinValue | integer | 否 | 定時任務的伸縮方式為設置伸縮組內實例數量時,指定伸縮組內實例的最小數量。 | 0 |
MaxValue | integer | 否 | 定時任務的伸縮方式為設置伸縮組內實例數量時,指定伸縮組內實例的最大數量。 | 10 |
DesiredCapacity | integer | 否 | 定時任務的伸縮方式為設置伸縮組內實例數量時,指定伸縮組內實例的期望實例數。 說明
伸縮組必須支持設置期望實例數,即在創(chuàng)建該伸縮組時指定了 DesiredCapacity 。
| 10 |
ScalingGroupId | string | 否 | 定時任務觸發(fā)時需要修改實例數量的伸縮組,填寫伸縮組 ID。 指定 | asg-bp18p2yfxow2dloq**** |
返回參數
示例
正常返回示例
JSON
格式
{
"ScheduledTaskId": "edRtShc57WGXdt8TlPbr****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|