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

スケジュールされたタスクを作成します。スケジュールされたタスクはスケーリングタスクの一種で、指定した時点で特定のスケーリングルールを自動的に実行できます。CreateScheduledTask API を呼び出してスケジュールされたタスクを作成し、コンピューティングリソースの自動スケーリングを実装できます。これにより、ビジネス継続性を確保し、リソースコストを最小限に抑えます。

今すぐお試しください

この 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

*ScalingGroup

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` を指定すると、スケジュールされたタスクは既存のスケーリングルールを使用します。`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 形式で指定します。時刻は UTC である必要があります。タスクの作成から 90 日を超えた時点をトリガー時刻として指定することはできません。 `RecurrenceType` を指定した場合、スケジュールされたタスクは `LaunchTime` で指定した時刻に繰り返しトリガーされます。 `RecurrenceType` を指定しない場合、スケジュールされたタスクは `LaunchTime` で指定した時刻に 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` 形式で 2 つの値を指定できます。A と B の有効値は 1～31 です。B は A 以上である必要があります。 `RecurrenceType` パラメーターを `Cron` に設定した場合、cron 式を指定できます。cron 式は UTC 時刻で記述し、分、時、日、月、曜日のフィールドで構成されます。式には、英字の L と W、およびワイルドカード文字 (コンマ (,)、疑問符 (?)、ハイフン (-)、アスタリスク (*)、番号記号 (#)、スラッシュ (/)) を含めることができます。 `RecurrenceType` パラメーターと `RecurrenceValue` パラメーターの両方を指定する必要があります。	1
TaskEnabled	boolean	任意	スケジュールされたタスクを有効にするかどうかを指定します。 true false デフォルト値：true。	true
LaunchExpirationTime	integer	任意	失敗したスケジュールされたタスクの再試行期間です。単位は秒です。有効値の範囲は 0～1800 です。デフォルト値：600。	600
MinValue	integer	任意	ScalingGroupId パラメーターを指定した場合のスケーリンググループ内のインスタンスの最小数。	0
MaxValue	integer	任意	ScalingGroupId パラメーターを指定した場合のスケーリンググループ内のインスタンスの最大数。	10
DesiredCapacity	integer	任意	ScalingGroupId パラメーターを指定した場合のスケーリンググループ内の希望するインスタンス数。説明スケーリンググループを作成する際には、`DesiredCapacity` パラメーターを指定する必要があります。	10
ScalingGroupId	string	任意	スケーリンググループの ID。このパラメーターを指定すると、スケジュールされたタスクがトリガーされたときにスケーリンググループ内のインスタンス数が変更されます。 `ScalingGroupId` を指定する場合は、`MinValue`、`MaxValue`、`DesiredCapacity` のうち、少なくとも 1 つのパラメーターも指定する必要があります。`ScheduledAction` と `ScalingGroupId` を同時に指定することはできません。	asg-bp18p2yfxow2dloq****

レスポンスフィールド

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

例

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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