CreateScheduledTask - Auto Scaling - Alibaba Cloud ドキュメントセンター

定期タスクを作成します。

操作説明

操作の説明

スケーリンググループでスケーリングアクティビティが実行中である、またはスケーリンググループが無効になっているなどの理由で定期ノードがスケーリングルールのトリガーに失敗した場合、定期ノードは LaunchExpirationTime 期間内にトリガーを自動的にリトライします。それ以外の場合、定期ノードのトリガーは破棄されます。
複数の定期ノードがほぼ同じ時間に同じスケーリンググループのスケーリングルールをトリガーする場合、トリガーされるスケーリングアクティビティの詳細は以下のとおりです。
- 期待されるインスタンス数のセットがあるスケーリンググループ: 複数の定期ノードによってトリガーされるスケーリングアクティビティは、並列スケーリングアクティビティとして分類されます。たとえば、複数の定期ノードがほぼ同じ時間に実行される場合、スケーリンググループは複数の並列スケーリングアクティビティを同時にトリガーできます。
- 期待されるインスタンス数のセットがないスケーリンググループ: 最も早くトリガーされた定期ノードが最初にスケーリングアクティビティを実行します。スケーリンググループでは一度に 1 つのスケーリングアクティビティしか実行できないため、後続の定期ノードは LaunchExpirationTime 期間内に定期トリガーを自動的にリトライします。前のスケーリングアクティビティが完了した後も、後続の定期ノードが LaunchExpirationTime 期間内にリトライを続けている場合、その定期ノードのスケーリングルールが実行され、対応するスケーリングアクティビティがトリガーされます。
定期ノードは、次の 2 つのスケーリングメソッドをサポートしています。
- ScheduledAction パラメーターを使用して、実行するスケーリングルールをセットします。
- ScalingGroupId パラメーターを使用して、スケーリンググループ内のインスタンス数をセットします。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ess:CreateScheduledTask

create

*スケーリンググループ。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	定期タスクが属するリージョンの ID。	cn-qingdao
ScheduledTaskName	string	任意	定期タスクの名前。名前は 2～64 文字である必要があります。先頭は英字または数字とし、英字、数字、アンダースコア (_)、ハイフン (-)、および期間 (.) を含めることができます。名前は、同じリージョンおよび Alibaba Cloud アカウント内で一意である必要があります。デフォルト値: ScheduledTaskId の値。	scheduled****
Description	string	任意	定期タスクの説明。説明の長さは 2～200 文字である必要があります。	Test scheduled task.
ScheduledAction	string	任意	定期タスクがトリガーされたときに実行されるスケーリングルールの一意識別子。このパラメーターを指定すると、定期タスクのスケーリングメソッドは既存のスケーリングルールの選択にセットされます。説明 ScheduledAction と ScalingGroupId を同じ時間に指定することはできません。	ari:acs:ess:cn-hangzhou:140692647**:scalingrule/asr-bp12tcnol686y1ik**
RecurrenceEndTime	string	任意	繰り返し実行される定期タスクの終了時間。時間は ISO 8601 規格の `YYYY-MM-DDThh:mmZ` フォーマットで指定します。時間は協定世界時 (UTC) でなければなりません。作成日から 365 日を超える時間を指定することはできません。	2014-08-17T16:55Z
LaunchTime	string	任意	定期タスクがトリガーされる時間。時間は ISO 8601 規格の `YYYY-MM-DDThh:mmZ` フォーマットで指定します。時間は協定世界時 (UTC) でなければなりません。作成日から 90 日を超える時間を指定することはできません。 RecurrenceType が指定されている場合、このパラメーターで指定された時間は、タスクが繰り返し実行される時間としてデフォルトでセットされます。 RecurrenceType が指定されていない場合、タスクは指定された日付と時間に 1 回だけ実行されます。	2014-08-17T16:52Z
RecurrenceType	string	任意	定期タスクの繰り返し頻度のタイプ。有効な値: `Daily`: 定期タスクは、指定された日数ごとに 1 回実行されます。 `Weekly`: 定期タスクは、毎週の指定された曜日に実行されます。 `Monthly`: 定期タスクは、毎月指定された日に実行されます。 `Cron`: 定期タスクは、指定された cron 式に基づいて実行されます。 RecurrenceType と RecurrenceValue の両方を指定する必要があります。	Daily
RecurrenceValue	string	任意	定期タスクの繰り返し頻度の値。 RecurrenceType が `Daily` にセットされている場合、指定できる値は 1 つだけです。有効な値: 1～31。 RecurrenceType が `Weekly` にセットされている場合、カンマ (,) で区切られた複数の値を指定できます。たとえば、日曜日、月曜日、火曜日、水曜日、木曜日、金曜日、土曜日の値は `0,1,2,3,4,5,6` です。 RecurrenceType が `Monthly` にセットされている場合、フォーマットは `A-B` です。A と B の有効値は 1～31 で、B は A 以上である必要があります。 RecurrenceType が `Cron` にセットされている場合、値は協定世界時 (UTC) の時間を表し、分、時、日、月、曜日の 5 つのフィールドを持つ式をサポートします。この式では、カンマ (,)、疑問符 (?)、ハイフン (-)、アスタリスク (*)、ナンバー記号 (#)、転送スラッシュ (/)、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。このパラメーターを指定すると、定期タスクのスケーリングメソッドはスケーリンググループ内のインスタンス数の指定にセットされます。MinValue、MaxValue、DesiredCapacity のいずれかのパラメーターに値を指定する必要があります。説明 ScheduledAction と ScalingGroupId を同じ時間に指定することはできません。	asg-bp18p2yfxow2dloq****

レスポンスフィールド

フィールド	型	説明	例
	object
ScheduledTaskId	string	定期タスクの ID。ID はシステムによって生成され、グローバルに一意です。	edRtShc57WGXdt8TlPbr****
RequestId	string	リクエスト ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

例

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。