CreateScheduledTask - 建立一個定時任務 - Auto Scaling

定時任務是一種預設任務，您可以通過調用API CreateScheduledTask建立一個定時任務，在指定時間執行指定伸縮規則，實現計算資源的自動擴張或收縮，來滿足業務需求的同時又能控製成本。

介面說明

由於伸縮組正在發生伸縮活動或者伸縮組停用等原因，導致定時任務觸發執行伸縮規則失敗後，在LaunchExpirationTime內，定時任務會自動重試觸發，否則放棄本次定時觸發。
如果多個定時任務在相近的時間內觸發執行同一個伸縮組的伸縮規則，則觸發的伸縮活動詳情如下：
- 已設定期望執行個體數的伸縮組：多個定時任務觸發的伸縮活動屬於並行伸縮活動。例如，相近時間內，執行多個定時任務後，伸縮組可同時觸發多個並行伸縮活動。
- 未設定期望執行個體數的伸縮組：最早觸發的定時任務會先執行伸縮活動。由於同一個伸縮組同一時刻內只能有一個伸縮活動，排在後面的定時任務會在LaunchExpirationTime內自動重試定時觸發。如果上一個伸縮活動完成之後，排在後面的定時任務還在LaunchExpirationTime內重試，則執行該定時任務的伸縮規則並觸發相應的伸縮活動。
定時任務支援以下兩種伸縮方式：
- 通過 ScheduledAction 參數設定需要執行的伸縮規則。
- 通過 ScalingGroupId 參數設定伸縮組內執行個體數量。
說明
不支援同時設定 ScheduledAction 和 ScalingGroupId。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ess:CreateScheduledTask

create

*ScalingGroup

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	定時任務所屬地區的 ID。	cn-qingdao
ScheduledTaskName	string	否	定時任務的名稱。2~64 個英文或中文字元，以數字、大小字母或中文開頭，可包含數字、底線（_）、短劃線（-）或半形句號（.）。同一帳號同一地區內唯一。預設值為`ScheduledTaskId`的值。	scheduled****
Description	string	否	定時任務的描述資訊，長度為 2~200 個英文或中文字元。	Test scheduled task.
ScheduledAction	string	否	定時任務觸發時需要執行的伸縮規則，填寫伸縮規則的唯一識別碼。指定`ScheduledAction`後，定時任務的伸縮方式為選擇已有伸縮規則。不支援同時設定`ScheduledAction`和`ScalingGroupId`。	ari:acs:ess:cn-hangzhou:140692647**:scalingrule/asr-bp12tcnol686y1ik**
RecurrenceEndTime	string	否	重複執行定時任務的結束時間。按照 ISO8601 標準表示，並需要使用 UTC 時間。格式為：YYYY-MM-DDThh:mmZ。不能填寫自建立當天起 365 日後的時間。	2014-08-17T16:55Z
LaunchTime	string	否	定時任務觸發的時間點。按照 ISO8601 標準表示，並需要使用 UTC 時間。格式為：YYYY-MM-DDThh:mmZ。不能填寫自建立當天起 90 日後的時間。如果指定了`RecurrenceType`，則此屬性指定的時間點，預設為迴圈執行的時間點。如果未指定`RecurrenceType`，則按指定的日期和時間執行一次。	2014-08-17T16:52Z
RecurrenceType	string	否	重複執行定時任務的類型，取值範圍： Daily：每多少天重複執行一次定時任務。 Weekly：每周指定幾天重複執行一次定時任務。 Monthly：每月內指定幾天重複執行一次定時任務。 Cron：按照指定的 Cron 運算式執行定時任務。您需要同時指定`RecurrenceType`和`RecurrenceValue`。	Daily
RecurrenceValue	string	否	重複執行定時任務的數值。 `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。您需要同時指定`RecurrenceType`和`RecurrenceValue`。	1
TaskEnabled	boolean	否	是否啟動定時任務。 true：啟動任務。 false：停止任務。預設值：true。	true
LaunchExpirationTime	integer	否	定時任務觸發操作失敗後，在此時間內重試。單位為秒，取值範圍：0~1800。預設值：600。	600
MinValue	integer	否	定時任務的伸縮方式為設定伸縮組內執行個體數量時，指定伸縮組內執行個體的最小數量。	0
MaxValue	integer	否	定時任務的伸縮方式為設定伸縮組內執行個體數量時，指定伸縮組內執行個體的最大數量。	10
DesiredCapacity	integer	否	定時任務的伸縮方式為設定伸縮組內執行個體數量時，指定伸縮組內執行個體的期望執行個體數。說明伸縮組必須支援設定期望執行個體數，即在建立該伸縮組時指定了`DesiredCapacity`。	10
ScalingGroupId	string	否	定時任務觸發時需要修改執行個體數量的伸縮組，填寫伸縮組 ID。指定`ScalingGroupId`後，定時任務的伸縮方式為設定伸縮組內執行個體數量，您需要為`MinValue`、`MaxValue`和`DesiredCapacity`中至少一個參數指定數量。不支援同時設定`ScheduledAction`和`ScalingGroupId`。	asg-bp18p2yfxow2dloq****

返回參數

名稱	類型	描述	樣本值
	object
ScheduledTaskId	string	定時任務的 ID，由系統產生，全域唯一。	edRtShc57WGXdt8TlPbr****
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

樣本

正常返回樣本

JSON格式

{
  "ScheduledTaskId": "edRtShc57WGXdt8TlPbr****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。