スケジュール済みタスクの作成
説明
この操作では、入力パラメーターに基づいてスケジュール済みタスクを作成します。
- 最大 20 個のスケジュール済みタスクを作成できます。
- スケーリンググループのスケーリングアクティビティが進行中、またはスケーリンググループが無効であることが原因で、スケジュール済みタスクのトリガーが失敗した場合は、LaunchExpirationTime 内に自動的に再試行されます。それ以外の場合、スケジュール済みトリガータスクは破棄されます。
- 同じグループのルールを実行する複数のタスクをほぼ同じ時刻にスケジュールした場合は、最も早いタスクが最初にスケーリングアクティビティをトリガーし、他のタスクはその開始有効期限内にルールの実行を試みます。これは、スケーリンググループでは、スケーリングアクティビティが一度に 1 つしか実行されないためです。スケーリングアクティビティが完了しても、依然として別のスケジュール済みタスクがその開始有効期限内にトリガーを試みている場合は、スケーリングルールが実行され、対応するスケーリングアクティビティがトリガーされます。
リクエストパラメーター
| 名前 | 型 | 必須かどうか | 説明 |
|---|---|---|---|
| Action | String | はい | 操作インターフェイス名、必須パラメーター。値: CreateScheduledTask。 |
| RegionId | String | はい | スケジュール済みタスクが存在するリージョンの ID。 |
| ScheduledAction | String | はい | スケジュール済みタスクがトリガーされたときに実行される操作。スケーリングルールの一意の ID を入力します。 |
| LaunchTime | String | はい | スケジュール済みタスクをトリガーする日時。 日付形式は ISO8601 標準、UTC 時刻を使用。YYYY-MM-DDThh:mmZ の形式。 RecurrenceType を指定した場合、この属性で指定した日時が、サイクルが実行されるデフォルトの日時になります。RecurrenceType を指定しなかった場合、タスクは指定された日時に一度だけ実行されます。 作成または変更から 90 日以降の日時を入力することはできません。 |
| ScheduledTaskName | String | いいえ | スケジュール済みタスクの表示名。2 ～ 40 文字で指定する必要があります (英語または中国語)。この名前は、数字、大文字/小文字の英字、または漢字で始まる必要があり、”_”、”-“、”.” を使用できます。 アカウント名は、同じリージョン内で一意です。 このパラメーターを指定しない場合は、デフォルト値の ScheduledScalingTaskId が使用されます。 |
| Description | String | いいえ | スケジュール済みタスクの説明。2 ～ 200 文字で指定する必要があります (英語または中国語)。 |
| LaunchExpirationTime | Integer | いいえ | スケジュール済みタスクが失敗した場合は、この期間内で再試行されます。 デフォルト値は 600 秒です。 値範囲: [0, 21600] |
| RecurrenceType | String | いいえ | 反復するスケジュール済みタスクのタイプ。オプション値: Daily: スケジュール済みタスクの日単位の反復間隔。 Weekly: スケジュール済みタスクの週単位の反復間隔。 Monthly: スケジュール済みタスクの月単位の反復間隔。 RecurrenceType、RecurrenceValue、および RecurrenceEndTime を指定する必要があります。 |
| RecurrenceValue | String | いいえ | 反復するスケジュール済みタスクの値。 Daily: [1,31] の範囲で 1 つの値のみを入力できます。 Weekly: 複数の値を入力できます。日曜日～土曜日の値は、順番に 0 ～ 6 です。複数の値を指定するときは、カンマ “,” で区切る必要があります。 Monthly: A-B の形式で指定します。A と B の値の範囲は 1 ～ 31 で、B の値は A の値より大きくする必要があります。 RecurrenceType、RecurrenceValue、および RecurrenceEndTime を指定する必要があります。 |
| RecurrenceEndTime | String | いいえ | 反復するスケジュール済みタスクの終了日時。 日付形式は ISO8601 標準、UTC 時刻を使用。YYYY-MM-DDThh:mmZ の形式。 作成または変更から 90 日以降の日時を入力することはできません。 RecurrenceType、RecurrenceValue、および RecurrenceEndTime を指定する必要があります。 |
| TaskEnabled | Bool | いいえ | スケジュール済みタスクを有効にするかどうかを指定します。 このパラメーターを true に設定すると、タスクが有効になります。 このパラメーターを false に設定すると、タスクが無効になります。 デフォルト値は true です。 |
リターンパラメーター
| 名前 | 型 | 説明 |
|---|---|---|
| ScheduledTaskId | String | スケジュール済みタスクの ID。システムによって生成され、グローバルに一意です。 |
エラーコード
すべてのインターフェイスに共通のエラーについては、「エラーコード表」のクライアントエラー または サーバエラーを参照してください。
| エラー | エラーコード | 説明 | HTTP ステータスコード |
|---|---|---|---|
| 指定したリージョンが存在しません。 | InvalidRegionId.NotFound | 指定したリージョンが存在しません。 | 404 |
| このスケジュール済みタスク名は既に存在します。 | InvalidScheduledTaskName.Duplicate | 指定したパラメーター <parameter name> の値が重複しています。 |
400 |
| 指定したスケジュール済みアクションと指定したスケジュール済みタスクが同じリージョンにありません。 | ScheduledAction.RegionMismatch | 指定したスケジュール済みタスクと指定したスケジュール済みアクションが同じリージョンにありません。 | 400 |
| スケジュール済みタスクのクォータを超過しています。 | QuotaExceeded.ScheduledTask | スケジュール済みタスクのクォータを超過しています。 | 400 |
例
リクエストの例
http://ess.aliyuncs.com/?Action=CreateScheduledTask&RegionId=cn-qingdao&LaunchTime=2014-08-17T16:52Z&RecurrenceType=Daily&RecurrenceValue=1&RecurrenceEndTime=2014-08-17T16:55Z&ScheduledAction=ari:acs:ess:cn-qingdao:1344371:scalingRule/cCBpdYdQuBe2cUxOdu6piOk&<Public Request Parameters>
戻り値の例
XML の例
<CreateScheduledTaskResponse><ScheduledTaskId>edRtShc57WGXdt8TlPbrjsnV</ScheduledTaskId><RequestId>0F02D931-2B12-44D7-A0E9-39925C13D15E</RequestId></CreateScheduledTaskResponse>
JSON 形式
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368","ScheduledTaskId": "edRtShc57WGXdt8TlPbrjsnV"