putScheduledUpdateGroupAction
    • PDF

    putScheduledUpdateGroupAction

    • PDF

    Article Summary

    概要

    スケジュールアクション作成/修正

    説明

    指定されたAuto Scaling Groupのためのスケーリングアクションスケジュールを作成または更新します。このアクション(Action)を呼び出す時、同じ名称のスケジュール名が既にある場合、そのスケジュールを変更し、ない場合はスケジュールを作成します。
    スケジュールの種類は、一回性スケジュールと繰り返しのスケジュールに区分されます。一回性スケジュールを作成したい場合はstart timeを指定して、繰り返し(recurrence)設定はセットしなければ作成できます。繰り返しスケジュールを設定したい場合は繰り返し設定をセットすれば設定できます。

    呼び出す時のパラメータであるMin size、Desired Capacityとmax sizeの中で、少なくとも一つは指定しなければなりません。
    スケジュールが実行される時、前に記述した3つのパラメータの中で指定されたパラメータのAuto Scaling Groupの該当属性を変更します。
    スケジュールによって変更されたAuto Scaling GroupのMin size, Desired Capacityとmax sizeは変更以降にもMin size <= Desired Capacity <= max sizeの関係を維持する必要があります。
    そうでない場合、スケジュールの適用が失敗して効果がありません。

    リクエストパラメータ

    ラメータ名必須タイプ制約事項説明
    autoScalingGroupNameYesStringMin : 1, Max : 255照会するAuto Scaling Group名を入力します。
    scheduledActionNameYesStringMin : 1, Max : 255スケーリングアクションスケジュール名であり、スケジュール識別子の役割をします。
    指定されたAuto Scaling Groupの中では唯一の名称である必要があります。
    このアクション(Action)を呼び出す時、同じ名称のスケジュール名が既にある場合はそのスケジュールを変更し、ない場合はスケジュールを作成します。
    desiredCapacityConditionalStringMin : 1, Max : 30サービスで期待されるキャパシティであり、該当するグループ所属で運営されるサーバインスタンスの数を設定します。
    この値はAuto Scalingにすでに設定されている既存属性のmin sizeより大きく、max sizeより小さく設定する必要があります。
    minSizeConditionalStringMin : 1, Max : 30最小サイズ(最小0で maxSizeの値より小さいか同じ)です。
    Min: 最小サイズ(minSize), Max: 最大サイズ(maxSize)
    Min: 0, Max: 30
    maxSizeConditionalStringMin : 1, Max : 30最大サイズ(最小0, 最大30)です。
    startTimeConditionalDateyyyy-MM-dd'T'HH:mm:ssZ繰り返しスケジュール設定(recurrenceInKST)がない場合は必須
    繰り返しスケジュール設定(recurrenceInKST)がある場合: 繰り返しスケジュールの開始時間
    format: yyyy-MM-dd'T'HH:mm:ssZ
    例)2013-07-25T17:50:00+0900, 2013-07-25T17:50:00+09:00
    endTimeNoDateyyyy-MM-dd'T'HH:mm:ssZ繰り返しスケジュール設定(recurrenceInKST)がある場合のみに指定可能
    繰り返しスケジュール設定(recurrenceInKST)がある場合: 繰り返しスケジュール設定終了時間
    format : yyyy-MM-dd'T'HH:mm:ssZ
    例)2013-07-25T17:50:00+0900, 2013-07-25T17:50:00+09:00
    recurrenceInKSTNoString例)50 23 * * Sun繰り返しスケジュール設定
    設定の形式は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: 毎月最初の日夜の12時: [0 0 1 * *]
    例示4: 毎年1月1日夜の12時: [0 0 1 Jan *]

    ※ CLI input parameter type : --recurrenceInKST "0 0 1 * *"

    レスポンスデータタイプ

    • ScheduledUpdateGroupActionListタイプ
    ScheduledUpdateGroupActionList extends CommonResponse
    private Integer totalRows;
    private List scheduledUpdateGroupActionList = new ArrayList();
    ScheduledUpdateGroupAction extends BaseObject
    private String autoScalingGroupName;
    private String scheduledActionName;
    private Integer desiredCapacity;
    private Integer minSize;
    private Integer maxSize;
    private Date startTime;
    private Date endTime;
    private String recurrenceInKST;

    例示

    呼び出し

    ncloud autoscaling putScheduledUpdateGroupAction --autoScalingGroupName testabc --scheduledActionName test3 --desiredCapacity 1 --minSize 1 --maxSize 1 --recurrenceInKST "0 0 1 * *"
    

    レスポンス

    {
      "putScheduledUpdateGroupActionResponse": {
        "requestId": "a3f3052e-2e0b-4ad9-8069-07853834493a",
        "returnCode": "0",
        "returnMessage": "success",
        "totalRows": 1,
        "scheduledUpdateGroupActionList": [
          {
            "autoScalingGroupName": "testabc",
            "scheduledActionName": "test3",
            "desiredCapacity": 1,
            "minSize": 1,
            "maxSize": 1,
            "startTime": "2018-05-01T00:00:00+0900",
            "recurrenceInKST": "0 0 1 * *"
          }
        ]
      }
    }
    
    <?xml version="1.0" encoding="UTF-8" ?>
    <putScheduledUpdateGroupActionResponse>
      <requestId>a3f3052e-2e0b-4ad9-8069-07853834493a</requestId>
      <returnCode>0</returnCode>
      <returnMessage>success</returnMessage>
      <totalRows>1</totalRows>
      <scheduledUpdateGroupActionList>
        <autoScalingGroupName>testabc</autoScalingGroupName>
        <scheduledActionName>test3</scheduledActionName>
        <desiredCapacity>1</desiredCapacity>
        <minSize>1</minSize>
        <maxSize>1</maxSize>
        <startTime>2018-05-01T00:00:00+0900</startTime>
        <recurrenceInKST>0 0 1 * *</recurrenceInKST>
      </scheduledUpdateGroupActionList>
    </putScheduledUpdateGroupActionResponse>
    

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.