- Print
- PDF
updateAutoScalingGroup
- Print
- PDF
Overview
Modify Auto-Scaling Group
Description
Renew the assigned Auto Scaling Group. The values of the assigned parameter’s properties will be changed, and the other values will stay the same.
Even though the minSize, desiredCapacity, or maxSize is changed due to this action, the order relations must be kept as follows,
maxSize >= desiredCapacity >= minSize. If the zoneNoList is changed, the zone rebalancing will be activated.
Once a new Launch Configuration is assigned via this action, the effect will be taken upon creation of a server instance.
Error code 50160 will occur if a call is made when Auto Scaling Group is operating scaling actions.
i ) When the minSize is assigned without the specific desiredCapacity, and a new minSize value
is greater than the current size of Auto Scaling Group, the setDesiredCapacity will be called and the group size will be set as the new minSize.
ii ) When the maxSize is assigned without the specific desiredCapacity, and a new maxSize value
is smaller than the current Auto Scaling Group, the setDesiredCapacity will be called and the group size will be set as the new maxSize.
iii) Other optional parameters not delivered while requesting will be left as the default value.
If none of the optional parameters are transferred, none of the property values will be changed. (There will be no error.)
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. |
launchConfigurationName | No | String | Min : 1, Max : 255 | The name of the launch configuration. Contains information about the server used when a new server instance belongs to the corresponding auto-scaling group. |
desiredCapacity | No | Integer | Min : 0, Max : 30 | Desired capacity sets the number of server instances that will be served by this group. This value should not be less than the existing attribute already set in auto-scaling, but not larger than max size. |
minSize | No | Integer | Min : 0, Max : 30 | The minimum size (at least 0 and less than or equal to the maxSize value). Min : 0, Max : 30 |
maxSize | No | Integer | Min : 0, Max : 30 | The maximum size (minimum 0, maximum 30). |
defaultCooldown | No | Integer | Min : 0, Max : 2147483647 | The default cooldown time. Default: Set to 300 seconds |
healthCheckGracePeriod | Conditional | Integer | Min : 0, Max : 2147483647 | Health check Sets the amount of time to hold a health check after a server instance is put into service for a hold period. healthCheckTypeCode Required if the value is a load balancer (LOADB). |
healthCheckTypeCode | No | String | Min : 1, Max : 5 | Currently available type codes are server (SVR) and load balancer (LOADB). |
zoneNoList | No | String | Redundant | Zone number list. Include a list of zone numbers where server instances belonging to this group will exist. ex) zone code: 2, zone name: KR-1 / zone code: 3, zone name: KR-2 |
Response Data type
- AutoScalingGroupList Type
AutoScalingGroupList extends CommonResponse |
---|
private Integer totalRows; |
private List |
AutoScalingGroup extends BaseObject |
---|
private String autoScalingGroupName; |
private String launchConfigurationName; |
private Integer desiredCapacity; |
private Integer minSize; |
private Integer maxSize; |
private Integer defaultCooldown; |
private List |
private Integer healthCheckGracePeriod; |
private CommonCode healthCheckType; |
private Date createDate; |
private List |
private List |
private List |
LoadBalancerInstanceSummary extends BaseObject |
---|
private String loadBalancerInstanceNo; |
private String loadBalancerName; |
InAutoScalingGroupServerInstance extends BaseObject |
---|
private CommonCode healthStatus; |
private CommonCode lifecycleState; |
private LaunchConfiguration launchConfiguration; |
private String serverInstanceNo; |
private String serverInstanceName; |
SuspendedProcess |
---|
private CommonCode process; |
private String suspensionReason; |
Zone |
---|
private String zoneNo; |
private String zoneName; |
private String zoneCode; |
private String zoneDescription; |
private String regionNo; |
private long totalMemorySize; |
private long totalUsedMemorySize; |
private long totalUsePossibleMemorySize; |
CommonCode |
---|
private String codeKind; |
private String detailCategorizeCode; |
private String code; |
private String codeName; |
private Integer codeOrder; |
private String javaConstantCode; |
LaunchConfiguration |
---|
private String launchConfigurationName; |
private String serverImageProductCode; |
private String serverProductCode; |
private String memberServerImageNo; |
private String loginKeyName; |
private Date createDate; |
private String userData; |
private List |
AccessControlGroup extends BaseObject |
---|
private String accessControlGroupConfigurationNo; |
private String accessControlGroupName; |
private String accessControlGroupDescription; |
private boolean isDefault; |
private Date createDate; |
Examples
Request
ncloud autoscaling updateAutoScalingGroup --autoScalingGroupName soso02 --launchConfigurationName test-autoscaling
Response
{
"updateAutoScalingGroupResponse": {
"requestId": "1669d3e8-0c5a-4521-ab50-3008bfced00d",
"returnCode": "0",
"returnMessage": "success",
"totalRows": 1,
"autoScalingGroupList": [
{
"autoScalingGroupName": "soso02",
"launchConfigurationName": "test-autoscaling",
"desiredCapacity": 0,
"minSize": 0,
"maxSize": 0,
"defaultCooldown": 12,
"loadBalancerInstanceSummaryList": [],
"healthCheckGracePeriod": 42,
"healthCheckType": {
"code": "SVR",
"codeName": "Server"
},
"createDate": "2017-08-18T14:11:49+0900",
"inAutoScalingGroupServerInstanceList": [],
"suspendedProcessList": [],
"zoneList": [
{
"zoneNo": "2",
"zoneName": "KR-1",
"zoneCode": "KR-1",
"zoneDescription": "KR-1 zone",
"regionNo": "1"
}
]
}
]
}
}
<?xml version="1.0" encoding="UTF-8" ?>
<updateAutoScalingGroupResponse>
<requestId>1669d3e8-0c5a-4521-ab50-3008bfced00d</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<autoScalingGroupList>
<autoScalingGroupName>soso02</autoScalingGroupName>
<launchConfigurationName>test-autoscaling</launchConfigurationName>
<desiredCapacity>0</desiredCapacity>
<minSize>0</minSize>
<maxSize>0</maxSize>
<defaultCooldown>12</defaultCooldown>
<loadBalancerInstanceSummaryList/>
<healthCheckGracePeriod>42</healthCheckGracePeriod>
<healthCheckType>
<code>SVR</code>
<codeName>Server</codeName>
</healthCheckType>
<createDate>2017-08-18T14:11:49+0900</createDate>
<inAutoScalingGroupServerInstanceList/>
<suspendedProcessList/>
<zoneList>
<zoneNo>2</zoneNo>
<zoneName>KR-1</zoneName>
<zoneCode>KR-1</zoneCode>
<zoneDescription>KR-1 zone</zoneDescription>
<regionNo>1</regionNo>
</zoneList>
</autoScalingGroupList>
</updateAutoScalingGroupResponse>