putScheduledUpdateGroupAction

VPC環境で利用できます。

Auto Scaling Groupの Scalingスケジュールを作成したり変更したりします。1回限りと繰り返しのスケジュールを設定できます。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET \| POST	/vautoscaling/v2/putScheduledUpdateGroupAction

参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

Auto Scaling APIで共通して使用されるヘッダの詳細は、Auto Scalingのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	リージョンコード getRegionListを参照照会結果の最初のリージョン(デフォルト)
`autoScalingGroupNo`	String	Required	Auto Scaling Group番号 getAutoScalingGroupListを参照
`scheduledActionNo`	String	Conditional	スケジュール番号 getScheduledActionListを参照スケジュール作成時、入力しないスケジュール変更時、`scheduledActionNo`、`scheduledActionName`のうち、いずれか1つは必ず入力
`scheduledActionName`	String	Conditional	スケジュール名新しい名前を入力するとスケジュールを作成英字の小文字、数字、記号の「-」を使用して1~255文字以内で入力文字列の先頭文字は英字の小文字、末尾文字は英字の小文字または数字のみ使用既存の名前を入力するとスケジュールを変更スケジュール名: getScheduledActionListを参照スケジュール作成時、必ず入力スケジュール変更時、`scheduledActionNo`、`scheduledActionName`のうち、いずれか1つは必ず入力
`minSize`	Integer	Required	最小容量: Auto Scaling Groupの最小サーバ数 0~30 `maxSize`以下に設定サーバを保有しない場合は0を入力
`maxSize`	Integer	Required	最大容量: Auto Scaling Groupの最大サーバ数 0~30 `minSize`以上に設定
`desiredCapacity`	Integer	Optional	希望する容量: Auto Scaling Groupの希望するサーバ数 `minSize`以上、`maxSize`以下に設定 (デフォルト: `minSize`と同じ) 入力値に応じてサーバ数を自動調整
`startTime`	String	Conditional	スケジュール開始日時 yyyy-MM-ddTHH:mm:ssZ形式現在の時刻以降で、`endTime`以前に設定 `recurrence`未設定時、必ず入力 `recurrence`設定時、`startTime`以降で、最も早い繰り返しスケジュールを実行 `recurrence`だけ設定時、最も早い繰り返しスケジュールを`startTime`で実行別のスケジュールの開始時刻と重複不可 <例> `2020-07-25T17:50:00+0900` (URLエンコードが必要)
`endTime`	String	Optional	スケジュール終了日時 yyyy-MM-ddTHH:mm:ssZ形式 `startTime`以降に設定 `recurrence`を設定するとその時刻以降、繰り返し実行を終了 <例> `2020-07-25T17:50:00+0900` (URLエンコードが必要)
`recurrence`	String	Optional	繰り返し設定 crontab形式(分時日月曜日) 分: 0~59 時: 0~23 日: 1~31 月: 1~12または英語表記曜日: 0~7または英語表記 0=7=Sun ``: 全選択 <例1> 毎時定刻: 0 * * * <例2> 毎週土曜日16時30分: 30 16 * * 6 <例3> 毎月1日の午前零時: 0 0 1 * * <例4> 毎年1月1日の午前零時 0 0 1 Jan *
`timeZone`	String	Optional	基準時間帯繰り返し設定の時間帯域を指定可能 `KST` (デフォルト) \| `UTC` `KST`: UTC+9 `UTC`: UTC+0
`responseFormatType`	String	Optional	レスポンスデータの形式 `xml`(デフォルト) \| `json`

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vautoscaling/v2/putScheduledUpdateGroupAction
?regionCode=KR
&autoScalingGroupNo=1***9
&scheduledActionName=sch2
&minSize=0
&maxSize=0
&desiredCapacity=0
&startTime=2025-06-14T17%3A50%3A00%2B0900
&endTime=2025-06-14T18%3A10%3A00%2B0900
&timeZone=KST
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`putScheduledUpdateGroupActionResponse`	Object	-	レスポンス結果 ScheduledUpdateGroupActionListを参照
`putScheduledUpdateGroupActionResponse.requestId`	String	-	リクエスト ID UUID形式
`putScheduledUpdateGroupActionResponse.returnCode`	String	-	レスポンスコード
`putScheduledUpdateGroupActionResponse.returnMessage`	String	-	レスポンスメッセージ

レスポンスステータスコード

Auto Scaling APIで共通して使用されるレスポンスステータスコードの詳細は、Auto Scalingのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
  "putScheduledUpdateGroupActionResponse": {
    "totalRows": 1,
    "scheduledUpdateGroupActionList": [
      {
        "autoScalingGroupNo": "1***9",
        "scheduledActionNo": "1183",
        "scheduledActionName": "sch2",
        "minSize": 0,
        "maxSize": 0,
        "desiredCapacity": 0,
        "startTime": "2025-06-14T17:50:00+0900",
        "endTime": "2025-06-14T18:10:00+0900",
        "recurrence": "",
        "timeZone": "KST"
      }
    ],
    "requestId": "daf32d70-****-****-****-de2a2da7f09f",
    "returnCode": "0",
    "returnMessage": "success"
  }
}