createAutoScalingGroup

Prev Next

Can be used in a VPC environment.

Summary

Create Auto Scaling Groups.

Request

Request Parameters

Parameter name Requirement status Type Restrictions Description
regionCode No String Region code
You can decide the region in which an Auto Scaling Group will be created.
You can obtain the regionCode through the getRegionList action.
Default: Select the first region of the getRegionList search results
launchConfigurationNo Yes String Launch Configuration number
Determine the Launch Configuration containing the information regarding the server that will be created with scale-out.
You can obtain the launchConfigurationNo through the getLaunchConfigurationList action.
autoScalingGroupName No String Min : 1, Max : 255
Only lower case English letters, numbers, and "-" are allowed, and it has to start with an English letter.
It must end with an English letter or number.		 Auto Scaling Group name
Default: NAVER Cloud Platform automatically grants it.
vpcNo Yes String VPC number
Determine the VPC to execute the Auto Scaling.
You can obtain the vpcNo through the getVpcList action.
subnetNo Yes String Subnet number
Determine the subnet to execute the Auto Scaling.
You can obtain the subnetNo through the getSubnetList action.
accessControlGroupNoList.N Yes List<String> Min: 1, Max: 3 List of ACG numbers applied to the server group created by scale-out
You can apply up to 3 ACGs.
You can obtain the accessControlGroupNo through the getAccessControlGroupList action.
ex) accessControlGroupNoList.1=1234&accessControlGroupNoList.2=2345
serverNamePrefix No String Min : 3, Max : 7
Only lower case English letters, numbers, and "-" are allowed, and it has to start with an English letter.
It must end with an English letter or number.		 The prefix of a server name created by scale-out
The rule for a server name is [Prefix]-[English letters|number], and the remaining English letters and numbers are automatically created except for the prefix set.
Default : s
minSize Yes Integer Min : 0, Max : 30 Minimum capacity
This is the minimum number of Auto Scaling Groups. The number of servers that are larger or equal to this value is always maintained. Set it to 0 if you want no server.
It must be less than or equal to the maxSize.
maxSize Yes Integer Min : 0, Max : 30 Maximum capacity
This is the allowed maximum number of servers in the Auto Scaling Group.
It must be more than or equal to the minSize.
desiredCapacity No Integer Min : 0, Max : 30 Desired capacity
The number of servers is adjusted depending on the expected capacity value.
It must be more than or equal to the minSize, and less than or equal to the maxSize.
Default: The same value as minSize
defaultCoolDown No Integer Min : 0, Max : 2147483647 Default cooldown
Even after a server is created, it may take some time to prepare the actual implementation of the service for various reasons, such as initialization script executions or update installations. Cooldown refers to the set time period which any monitoring event notifications occurring during or after scaling are ignored with no response to them.
Default: 300 seconds
healthCheckGracePeriod Conditional Integer Min : 0, Max : 2147483647 Health check grace period
Even though the server instance has been created and is in the "Running" status, it might not respond to the health check due to other tasks, such as server update installations. In this case, you can specify the health check grace period during so that the server is not considered to have an issue even if the health check fails.
You must enter when the healthCheckTypeCode is LOADB.
Default: 300 seconds
healthCheckTypeCode No String Health check type code
You can decide the health check type.
You must enter the healthCheckGracePeriod value when it is LOADB. You can specify the list of target groups, and the server status is determined depending on the health check method and criteria of each target group.
Options : SVR (Server) | LOADB (Load Balancer)
Default : SVR
targetGroupNoList.N No List<String> List of target group numbers
It is valid only when the healthCheckTypeCode is LOADB, and the server status can be determined depending on the health check method and criteria of each target group.
You can obtain the targetGroupNo through the getTargetGroupList action.
ex) targetGroupNoList.1=1234&targetGroupNoList.2=2345
responseFormatType No String Format type of the response results
Options : xml | json
Default : xml

Response

Response data type

  • AutoScalingGroupList type
AutoScalingGroupList extends CommonResponse
private Integer totalRows;
private List autoScalingGroup = new ArrayList<>();
AutoScalingGroup
private String vpcNo;
private String subnetNo;
private String serverNamePrefix;
private String autoScalingGroupNo;
private String autoScalingGroupName;
private String launchConfigurationNo;
private Integer minSize;
private Integer maxSize;
private Integer desiredCapacity;
private Integer defaultCoolDown;
private Integer healthCheckGracePeriod;
private CommonCode healthCheckType;
private Date createDate;
private CommonCode autoScalingGroupStatus;
private TargetGroupNoList targetGroupNoList;
private List inAutoScalingGroupServerInstanceList;
private AccessControlGroupNoList accessControlGroupNoList;
private List suspendedProcessList;
TargetGroupNoList
private List targetGroupNoList = new ArrayList<>();
InAutoScalingGroupServerInstance
private String serverInstanceNo;
private CommonCode healthStatus;
private CommonCode lifecycleState;
AccessControlGroupNoList
private List accessControlGroupNoList = new ArrayList<>();
SuspendedProcess
private CommonCode process;
private String suspensionReason;

Example

Request example

ncloud vautoscaling createAutoScalingGroup --regionCode KR --launchConfigurationNo ***163 --autoScalingGroupName test-*** --vpcNo ***04 --subnetNo ***43 --accessControlGroupNoList ***63 --serverNamePrefix test --minSize 0 --maxSize 0 --desiredCapacity 0 --defaultCoolDown 300 --healthCheckGracePeriod 300 --healthCheckTypeCode SVR

Response example

<createAutoScalingGroupResponse>
  <requestId></requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <autoScalingGroupList>
    <autoScalingGroup>
      <vpcNo>***04</vpcNo>
      <subnetNo>***43</subnetNo>
      <serverNamePrefix>test</serverNamePrefix>
      <autoScalingGroupNo>***700</autoScalingGroupNo>
      <autoScalingGroupName>test-***</autoScalingGroupName>
      <launchConfigurationNo>***163</launchConfigurationNo>
      <minSize>0</minSize>
      <maxSize>0</maxSize>
      <desiredCapacity>0</desiredCapacity>
      <defaultCoolDown>300</defaultCoolDown>
      <healthCheckGracePeriod>300</healthCheckGracePeriod>
      <healthCheckType>
        <code>SVR</code>
        <codeName>Server</codeName>
      </healthCheckType>
      <createDate>2020-12-07T13:10:30+0900</createDate>
      <autoScalingGroupStatus>
        <code>CREAT</code>
        <codeName>Created</codeName>
      </autoScalingGroupStatus>
      <targetGroupNoList/>
      <inAutoScalingGroupServerInstanceList/>
      <accessControlGroupNoList>
        <accessControlGroupNo>***63</accessControlGroupNo>
      </accessControlGroupNoList>
      <suspendedProcessList/>
    </autoScalingGroup>
  </autoScalingGroupList>
</createAutoScalingGroupResponse>