setDesiredCapacity

Article summary

Did you find this summary helpful?

Thank you for your feedback

Overview

Adjust desired capacity

Description

Desired capacity configuration regarding the assigned Auto Scaling Group

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.
desiredCapacity	Yes	Integer	Min : 0, Max : 30	New desired capacity configuration of the assigned group The value must not be smaller than the min size or greater than the max size of previously set properties under Auto Scaling Group.

Response Data type

AutoScalingGroupList Type

AutoScalingGroupList extends CommonResponse
private Integer totalRows;
private List autoScalingGroupList = new ArrayList();

AutoScalingGroup extends BaseObject
private String autoScalingGroupName;
private String launchConfigurationName;
private Integer desiredCapacity;
private Integer minSize;
private Integer maxSize;
private Integer defaultCooldown;
private List loadBalancerInstanceSummaryList;
private Integer healthCheckGracePeriod;
private CommonCode healthCheckType;
private Date createDate;
private List inAutoScalingGroupServerInstanceList;
private List suspendedProcessList;
private List zoneList;

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 accessControlGroupList;

AccessControlGroup extends BaseObject
private String accessControlGroupConfigurationNo;
private String accessControlGroupName;
private String accessControlGroupDescription;
private boolean isDefault;
private Date createDate;

Examples

Request

ncloud autoscaling setDesiredCapacity --autoScalingGroupName soso02 --desiredCapacity 5

Response

{
  "setDesiredCapacityResponse": {
    "requestId": "e1e84571-50a0-451f-8acb-ff8dce840ecc",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 1,
    "autoScalingGroupList": [
      {
        "autoScalingGroupName": "soso02",
        "launchConfigurationName": "test-autoscaling",
        "desiredCapacity": 5,
        "minSize": 0,
        "maxSize": 30,
        "defaultCooldown": 12,
        "loadBalancerInstanceSummaryList": [],
        "healthCheckGracePeriod": 42,
        "healthCheckType": {
          "code": "SVR",
          "codeName": "Server"
        },
        "createDate": "2017-08-18T14:11:49+0900",
        "inAutoScalingGroupServerInstanceList": [
          {
            "healthStatus": {
              "code": "HLTHY",
              "codeName": "Healthy (normal)"
            },
            "lifecycleState": {
              "code": "PNDNG",
              "codeName": "Pending status"
            },
            "launchConfiguration": {
              "launchConfigurationName": "test-autoscaling",
              "serverImageProductCode": "SPSW0LINUX000044",
              "serverProductCode": "SPSVRSTAND000003",
              "memberServerImageNo": "",
              "loginKeyName": "packer-1522153936",
              "createDate": "2018-04-05T14:53:16+0900",
              "userData": ""
            },
            "serverInstanceNo": "401886",
            "serverInstanceName": "s-3a1ry5007bc39y001"
          },
          {
            "healthStatus": {
              "code": "HLTHY",
              "codeName": "Healthy (normal)"
            },
            "lifecycleState": {
              "code": "PNDNG",
              "codeName": "Pending status"
            },
            "launchConfiguration": {
              "launchConfigurationName": "test-autoscaling",
              "serverImageProductCode": "SPSW0LINUX000044",
              "serverProductCode": "SPSVRSTAND000003",
              "memberServerImageNo": "",
              "loginKeyName": "packer-1522153936",
              "createDate": "2018-04-05T14:53:16+0900",
              "userData": ""
            },
            "serverInstanceNo": "401889",
            "serverInstanceName": "s-3a1ry5007bc39y002"
          }
        ],
        "suspendedProcessList": [],
        "zoneList": [
          {
            "zoneNo": "2",
            "zoneName": "KR-1",
            "zoneCode": "KR-1",
            "zoneDescription": "KR-1 zone",
            "regionNo": "1"
          }
        ]
      }
    ]
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<setDesiredCapacityResponse>
  <requestId>e1e84571-50a0-451f-8acb-ff8dce840ecc</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <autoScalingGroupList>
    <autoScalingGroupName>soso02</autoScalingGroupName>
    <launchConfigurationName>test-autoscaling</launchConfigurationName>
    <desiredCapacity>5</desiredCapacity>
    <minSize>0</minSize>
    <maxSize>30</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>
      <healthStatus>
        <code>HLTHY</code>
        <codeName>Healthy (normal)</codeName>
      </healthStatus>
      <lifecycleState>
        <code>PNDNG</code>
        <codeName>Pending status</codeName>
      </lifecycleState>
      <launchConfiguration>
        <launchConfigurationName>test-autoscaling</launchConfigurationName>
        <serverImageProductCode>SPSW0LINUX000044</serverImageProductCode>
        <serverProductCode>SPSVRSTAND000003</serverProductCode>
        <memberServerImageNo></memberServerImageNo>
        <loginKeyName>packer-1522153936</loginKeyName>
        <createDate>2018-04-05T14:53:16+0900</createDate>
        <userData></userData>
      </launchConfiguration>
      <serverInstanceNo>401886</serverInstanceNo>
      <serverInstanceName>s-3a1ry5007bc39y001</serverInstanceName>
    </inAutoScalingGroupServerInstanceList>
    <inAutoScalingGroupServerInstanceList>
      <healthStatus>
        <code>HLTHY</code>
        <codeName>Healthy (normal)</codeName>
      </healthStatus>
      <lifecycleState>
        <code>PNDNG</code>
        <codeName>Pending status</codeName>
      </lifecycleState>
      <launchConfiguration>
        <launchConfigurationName>test-autoscaling</launchConfigurationName>
        <serverImageProductCode>SPSW0LINUX000044</serverImageProductCode>
        <serverProductCode>SPSVRSTAND000003</serverProductCode>
        <memberServerImageNo></memberServerImageNo>
        <loginKeyName>packer-1522153936</loginKeyName>
        <createDate>2018-04-05T14:53:16+0900</createDate>
        <userData></userData>
      </launchConfiguration>
      <serverInstanceNo>401889</serverInstanceNo>
      <serverInstanceName>s-3a1ry5007bc39y002</serverInstanceName>
    </inAutoScalingGroupServerInstanceList>
    <suspendedProcessList/>
    <zoneList>
      <zoneNo>2</zoneNo>
      <zoneName>KR-1</zoneName>
      <zoneCode>KR-1</zoneCode>
      <zoneDescription>KR-1 zone</zoneDescription>
      <regionNo>1</regionNo>
    </zoneList>
  </autoScalingGroupList>
</setDesiredCapacityResponse>

Was this article helpful?

What's Next

terminateServerInstanceInAutoScalingGroup

Table of contents

Overview
Description
Request Parameters
Response Data type
Examples