putScheduledUpdateGroupAction

Prev Next

VPC環境で利用できます。

概要

Scaling Actionスケジュールを作成または修正します。
1回限りのスケジュールと繰り返しスケジュールを設定できます。
1回限りのスケジュールを作成するにはstartTimeを指定して、recurrenceを設定しません。
繰り返しスケジュールを作成するには、recurrenceを設定します。 (startTimeと同時に設定すると、startTime以降から繰り返しスケジュールが実行されます。)

リクエスト

リクエストパラメータ

パラメータ名 必須有無 タイプ 制約事項 説明
regionCode No String リージョンコード
Scheduled Actionを作成または修正するAuto Scaling Groupのリージョン(Region)を決定できます。
regionCodeはgetRegionListアクションを通じて取得できます。
Default：getRegionList照会結果の最初のリージョンを選択
autoScalingGroupNo Yes String Auto Scaling Group番号
autoScalingGroupNoはgetAutoScalingGroupListアクションを通じて取得できます。
scheduledActionNo Conditional String 修正するScheduled Action番号
Scheduled Action番号を用いて修正するスケジュールを指定できます。
新しいScheduled Actionを作成する場合は入力しません。
修正する場合、scheduledActionNoとscheduledActionNameのうち、一つを必ず入力します。
scheduledActionNoはgetScheduledActionListアクションを通じて取得できます。
scheduledActionName Conditional String Min : 1, Max : 255
小文字、数字、特殊文字のハイフン「-」のみが認められ、最初の文字をアルファベットにしてください。
アルファベットまたは数字で終わるようにしてください。		 Scheduled Action名
新たに作成するScheduled Action名を入力するか、修正するScheduled Action名を入力することができます。
指定した名前のScheduled Actionが既に存在する場合、当該Scheduled Actionの内容が修正されます。
修正する場合、scheduledActionNoとscheduledActionNameのうち、一つを必ず入力します。
作成する場合は、必ずscheduledActionNameを入力します。
scheduledActionNameはgetScheduledActionListアクションを通じて取得できます。
minSize Yes Integer Min : 0, Max : 30 最小容量
Auto Scaling Groupの最小サーバ数です。 常にこの値以上のサーバ数が維持されます。 サーバを1台も保有しないことを可能にするためには、0に設定します。
当該Actionに応じてAuto Scaling Groupの最小容量設定が変更されます。
maxSize以下でなければなりません。
maxSize Yes Integer Min : 0, Max : 30 最大容量
Auto Scaling Groupで作成可能な最大サーバ数です。
当該Actionに応じてAuto Scaling Groupの最大容量設定が変更されます。
minSize以上でなければなりません。
desiredCapacity Yes Integer Min : 0, Max : 30 希望する容量
希望する容量に応じてサーバ数が調整されます。
当該Actionに応じてAuto Scaling Groupの希望する容量設定が変更されます。
minSize以上でなおかつmaxSize以下でなければなりません。
startTime Conditional Date yyyy-MM-ddTHH:mm:ssZ スケジュール開始日時
スケジュールが最初に開始される日付と時刻を決定できます。
recurrenceと同時に入力すると、startTime以降、最も早い繰り返しスケジュールにActionが実行されます。
recurrenceのみ入力する場合、最も早い繰り返しスケジュールがstartTimeに指定されます。
recurrenceを入力しない場合、startTimeを必ず入力します。
他のスケジュールはstartTimeと重複してはならず、現在より以降の時刻、endTimeより以前の時刻でなければなりません。
format : yyyy-MM-ddTHH:mm:ssZ
ex) 2020-07-25T17:50:00+0900, 2020-07-25T17:50:00+09:00
endTime No Date yyyy-MM-ddTHH:mm:ssZ スケジュールの終了日時
繰り返しスケジュールが終了する日付と時刻を決定できます。
現在より以降の時刻、startTimeより以降の時刻でなければなりません。
format : yyyy-MM-ddTHH:mm:ssZ
ex) 2020-07-25T17:50:00+0900, 2020-07-25T17:50:00+09:00
recurrence No String crontab expression 繰り返し設定
繰り返しスケジュールをcrontab形式で指定できます。
分(minute) / 時(hour) / 日付(day of month) / 月(month) / 曜日(day of week)フィールドを、空白文字を区切り文字にして記載します。
各フィールドに入力できる有効な値は以下のとおりです。
0-59
0-23
1-31
1-12(または月の英語名)
0-7(または曜日の英語名、0または7が日曜日)
また、すべてのフィールド値としてasterisk *文字を使用することができ、最初の値から最後の値までの全部を意味します。
ex 1) 毎時定刻 0 * * * *
ex 2) 毎土曜日16時30分 30 16 * * 6
ex 3) 毎月1日の午前零時 0 0 1 * *
ex 4) 毎年1月1日の午前零時 0 0 1 Jan *
timeZone No String 時間帯域
繰り返し設定の時間帯域を指定できます。
Options : KST (UTC+9) | UTC (UTC+0)
Default : KST
responseFormatType No String レスポンス結果のフォーマットタイプ
Options : xml | json
Default : xml

レスポンス

レスポンスデータのタイプ

  • ScheduledUpdateGroupActionListタイプ
ScheduledUpdateGroupActionList extends CommonResponse
private Integer totalRows;
private List scheduledUpdateGroupActionList = new ArrayList<>();
ScheduledUpdateGroupAction
private String autoScalingGroupNo;
private String scheduledActionNo;
private String scheduledActionName;
private Integer minSize;
private Integer maxSize;
private Integer desiredCapacity;
private Date startTime;
private Date endTime;
private String recurrence;
private String timeZone;

例

リクエスト例

ncloud vautoscaling putScheduledUpdateGroupAction --regionCode KR --autoScalingGroupNo ***700 --scheduledActionName test-*** --minSize 0 --maxSize 0 --desiredCapacity 0 --startTime "2020-12-15T17:00:00+0900" --endTime "2020-12-15T18:00:00+0900" --recurrence "5 * * * *" --timeZone KST

レスポンス例

<putScheduledUpdateGroupActionResponse>
  <requestId></requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <scheduledUpdateGroupActionList>
    <scheduledUpdateGroupAction>
      <autoScalingGroupNo>***700</autoScalingGroupNo>
      <scheduledActionNo>***281</scheduledActionNo>
      <scheduledActionName>test-***</scheduledActionName>
      <minSize>0</minSize>
      <maxSize>0</maxSize>
      <desiredCapacity>0</desiredCapacity>
      <startTime>2020-12-15T17:05:00+0900</startTime>
      <endTime>2020-12-15T18:00:00+0900</endTime>
      <recurrence>5 * * * *</recurrence>
      <timeZone>KST</timeZone>
    </scheduledUpdateGroupAction>
  </scheduledUpdateGroupActionList>
</putScheduledUpdateGroupActionResponse>