putScheduledUpdateGroupAction

Article summary

Did you find this summary helpful?

Thank you for your feedback

Overview

Create or renew a scaling action schedule

Description

Create or renew a scaling action schedule for the assigned Auto Scaling Group.
If there is a schedule with the same name while calling this action, change the schedule.
If not, create a new schedule. The schedule types are divided into one-time and recurrent schedules.
If you wish to create a one-time schedule, adjust start time and do not set recurrence. Select recurrence for a recurrent schedule.

One of three parameters, min size, desired capacity, or max size, must be assigned while calling.
When a schedule is operating, change Auto Scaling Group’s properties of the assigned parameter.
The min size, desired capacity, and max size of Auto Scaling Group changed by the schedule must comply with their order relations
as min size <= desired capacity <=max size. Otherwise, the schedule will not be applied.

Request Parameters

Parameter	Required	Type	Restrictions	Description
autoScalingGroupName	Yes	String	Min : 1, Max : 255	Enter the name of the auto-scaling group you want to view.
scheduledActionName	Yes	String	Min : 1, Max : 255	The name of the scaling action schedule, which acts as a schedule identifier It must be unique within the specified Auto Scaling Group. When calling this action, change the schedule name if it already exists with the same name, or create a schedule.
desiredCapacity	Conditional	String	Min : 1, Max : 30	Number of server instances to be operated under the assigned group. This value should not be less than the existing attribute already set in auto-scaling, but not larger than max size.
minSize	Conditional	String	Min : 1, Max : 30	The minSize of the assigned group Min : 0, Max : 30
maxSize	Conditional	String	Min : 1, Max : 30	The maxSize must be smaller than or equal to 30.
startTime	Conditional	Date	yyyy-MM-dd'T'HH:mm:ssZ	Required if there is no recurrence schedule (recurrenceInKST) If there is a recurrence schedule (recurrenceInKST): Repeat schedule start time format : yyyy-MM-dd'T'HH:mm:ssZ ex) 2013-07-25T17:50:00+0900, 2013-07-25T17:50:00+09:00
endTime	No	Date	yyyy-MM-dd'T'HH:mm:ssZ	It can be specified only when there is a recurrence schedule setting (recurrenceInKST). When there is a recurrence schedule (recurrenceInKST): End time of recurrence schedule setting format : yyyy-MM-dd'T'HH:mm:ssZ ex) 2013-07-25T17:50:00+0900, 2013-07-25T17:50:00+09:00
recurrenceInKST	No	String	예)50 23 * * Sun	Set recurring schedule The setting type is crontab setting method. The minute, hour, day of month, month, and day of week fields You can list whitespace characters as delimiters. Valid values ??that can be entered in the minute and hour and day of month, month, and day of week fields are: They are 0-59, 0-23, 1-31, 1-12 (or Moon English name), 0-7 (0 or 7 is Sunday, or English name of the day) You can put asterisk ('') as a field value, which means all the first to the last values Below is an example. (Do not use brackets ([]) in the example and enter them as one line) Example 1: Hourly hour: [0 * * ] Example 2: Every Saturday 16:30: [30 16 * 6] Example 3: Midnight on the first day of every month: [0 0 1 * ] Example 4: Every January 1, midnight: [0 0 1 Jan ] ※ CLI input parameter type : --recurrenceInKST "0 0 1 * *"

Response Data type

ScheduledUpdateGroupActionList Type

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;

Examples

Request

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

Response

{
  "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>

Was this article helpful?

What's Next

deleteScheduledAction

Table of contents

Overview
Description
Request Parameters
Response Data type
Examples