概要
指定された Auto Scaling Groupの scaling actionスケジュールを作成したり更新したりします。
このアクション(Action)を呼び出す際、同じ名前のスケジュール名が既に存在する場合はそのスケジュールを変更し、そうでない場合はスケジュールを作成します。
スケジュールは、1回限りのスケジュールと繰り返しスケジュールに分けられます。
1回限りのスケジュールを作成したい場合は、start timeを指定して繰り返し(recurrence)設定はしないでください。繰り返しスケジュールを設定したい場合は、繰り返し設定を行います。
呼び出し時のパラメータのうち、Min size、Desired Capacity、max sizeの3つのうち少なくとも1つは指定されている必要があります。
スケジュールが実行されると、上記の3つのパラメータのうち、指定されたパラメータの Auto Scaling Groupの対応する属性を変更します。
スケジュールによって変更された Auto Scaling Groupの Min size、Desired Capacity、max sizeは、変更後も Min size <= Desired Capacity <= max sizeの大小関係を維持する必要があります。
そうしないとスケジュールの適用に失敗しても効果は発生しません。
リクエスト
リクエストパラメータ
パラメータ名 | 必須の有無 | タイプ | 制限事項 | 説明 |
---|---|---|---|---|
autoScalingGroupName | Yes | String | 最小: 1 最大: 255 |
照会対象のオートスケーリンググループ名を入力 |
scheduledActionName | Yes | String | 最小: 1 最大: 255 |
- スケーリングアクションスケジュール名 スケジュール識別子の役割として指定された Auto Scaling Group内では一意の名前 このアクション(Action)を呼び出す際、同じ名前のスケジュール名が既に存在する場合はそのスケジュールを変更し、そうでない場合はスケジュールを作成 |
desiredCapacity | Conditional | String | 最小: 1, 最大: 30 | - 希望するサービス能力 グループに属して運用されるサーバインスタンス数を設定 この値はオートスケーリングに既に設定されている既存の属性である min sizeより小さくてはならず、max sizeより大きくてはならない |
minSize | Conditional | String | 最小: 1, 最大: 30 | 最小サイズ 最小値は0で、maxSize以下にすること |
maxSize | Conditional | String | 最小: 1, 最大: 30 | 最大サイズ |
startTime | Conditional | Date | yyyy-MM-dd’T’HH:mm:ssZ | recurrenceInKST (繰り返しスケジュール設定)がない場合は、必須format : yyyy-MM-dd'T'HH:mm:ssZ 例) 2018-07-25T17:50:00+0900 |
endTime | No | Date | yyyy-MM-dd’T’HH:mm:ssZ | recurrenceInKST (繰り返しスケジュール設定)がない場合は、必須format : yyyy-MM-dd'T'HH:mm:ssZ 例) 2018-07-25T17:50:00+0900 |
recurrenceInKST | No | String | - | - 繰り返しスケジュール設定 設定形式は crontab設定方法 分(minute)、時(hour)、日付(day of month)、月(month)、曜日(day of week)フィールドを、空白文字を区切り文字にして記載 分(minute)と時(hour)と日付(day of month)、月(month)、曜日(day of week)フィールドに入力できる有効な値は、それぞれ 0-59 0-23 1-31 1-12 (または月の英語名)0-7 (または曜日の英語名、0または7が日曜日) フィールドに asterisk「*」は入力可能で、最初から最後までの値全部を意味 例1: 毎時定刻: 0 * * * * 例2: 毎土曜日16時30分: 30 16 * * 6 例3: 毎月初日の午前零時: 0 0 1 * * 例4: 毎年1月1日の午前零時 0 0 1 Jan * |
responseFormatType | No | String | - レスポンス結果の形式タイプ オプション: xml | json デフォルト: xml |
レスポンス
レスポンスボディ
例
リクエスト例
{AUTOSCALILNG_API_URL}/putScheduledUpdateGroupAction
?autoScalingGroupName=asg-0212
&desiredCapacity=3
&scheduledActionName=sa-0303
&startTime=2014-03-05T10%3A00%3A00%2B0900
レスポンス例
<putScheduledUpdateGroupActionResponse>
<requestId>948b7bc1-47e6-4d5c-a71d-e85622ab16ef</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<scheduledUpdateGroupActionList>
<scheduledUpdateGroupAction>
<autoScalingGroupName>asg-0212</autoScalingGroupName>
<scheduledActionName>sa-0303</scheduledActionName>
<desiredCapacity>3</desiredCapacity>
<startTime>2014-03-05T10:00:00+0900</startTime>
<recurrenceInKST />
</scheduledUpdateGroupAction>
</scheduledUpdateGroupActionList>
</putScheduledUpdateGroupActionResponse>
エラーコード
以下のエラーコードは、このアクション(Action)で発生する特徴的なエラーです。共通して発生するエラーについての詳細説明は、NAVERクラウドプラットフォーム APIをご参照ください。
HTTP Response Code | リターンコード | リターンメッセージ |
---|---|---|
400 | 50100 | The named Auto Scaling group or launch configuration already exists. |
400 | 50130 | The quota for capacity groups or launch configurations for this customer has already been reached. |