[중요] API 활용 가이드 문서 지원 종료 (Deprecated) 안내

본 API 문서는 네이버 클라우드 플랫폼의 확장성 있는 API 제공을 위해 Deprecated 되어 공식적으로 사용하지 않으며, 앞으로 사용이 정지될 예정입니다. (2018년 12월)
새롭게 제공되는 Ncloud APIs 가이드에서 네이버 클라우드 플랫폼의 API 사용 방법을 확인해 주십시오.



=========================================== @deprecated 문서(~2018년12월) ==========================================



들어가며

Auto Scaling 서비스 API로 RESTful API를 제공합니다. API의 URL의 도메인 이름 부분은 모든 네이버 클라우드 플랫폼 서비스가 공통적으로 사용하는 ‘api.ncloud.com’입니다. Auto Scaling 서비스를 사용하기 위해서는 URL의 최상위 경로(path)가 ‘/autoscaling/’이어야 합니다. 그리고 실행할 action을 파라미터로 정하고 그 action의 파라미터도 URL 파라미터로 정해서 호출합니다. 따라서 Auto Scaling용 쿼리 API URL은 다음과 같은 형태입니다.

- HTTP 프로토콜 이용: https://api.ncloud.com/autoscaling/?action=<api-name>&<param>=<val>
- HTTPS 프로토콜을 이용: https://api.ncloud.com/autoscaling/?action=<api-name>&<param>=<val>

자세한 설명은 [설명서 > Networking > 로드밸런서 > 로드밸런서 API > 서버-로드밸런서 API reference]에 기재되어 있습니다.

액션(Action)

createAutoScalingGroup

설명

식별자 역할을 하는 이름과 여타 속성을 지정해서 새로운 Auto Scaling Group을 생성합니다. 생성 요청이 완료되면, Auto Scaling Group은 다른 호출에서 사용될 완성된 상태가 되어 있습니다. 단, 생성 요청이 완료되었다고, 그룹 소속의 서버 인스턴스들이 생성이 완료되어 서비스에 투입이 완료됨을 보장하지는 않습니다.

요청 파라미터

모든 action에서 사용되는 공통 파라미터에 대한 상세 설명은 [설명서 > Networking > 로드밸런서 > 로드밸런서 API > 서버-로드밸런서 API reference]의 [API 개요]를 참조하세요.

파라미터 이름 간략 설명 타입 제약 필수 여부
autoScalingGroupName Auto Scaling Group의 이름 String 최소 길이 1바이트, 최대 길이 255바이트
이름은 영어 소문자, 숫자와 하이픈(‘-‘)으로 이루어져야 합니다
단, 첫글자는 영문자이고, 마지막 문자는 영문자 또는 숫자여야 합니다
Yes
launchConfigurationName Launch Configuration 이름 String 최소 길이 1바이트, 최대 길이 255바이트 Yes
desiredCapacity 기대 서비스 능력
그 그룹 소속으로 운영될 서버 인스턴스들의 수
Integer minSize보다 크거나 같고 maxSize보다 작거나 같아야 함 No
minSize 최소 사이즈
Auto Scaling Group의 최소 사이즈
Integer 최소 0이고 maxSize 값보다 작거나 같아야 함 Yes
>maxSize 최대 사이즈
Auto Scaling Group의 최대 사이즈
Integer 최소 0, 최대 100 Yes
defaultCooldown 디폴트 cooldown 시간 Integer 0 이상의 정수 No
loadBalancerNameList 로드밸런서 이름 리스트
이 그룹 소속 서버가 생성되어 서비스에 투입될 때 등록될 로드밸런서 이름 리스트
String No
healthCheckGracePeriod health check 보류 기간
단위는 초(sec)
서버 인스턴스가 서비스에 투입된 이후 health check를 보류할 시간
Integer 최소 0 Conditional
healthCheckTypeCode Health check 유형 코드
현재 서버 type과 로드밸런서 type이 있습니다
String SVR과 LOADB가 유효함 No
zoneNoList Zone 번호 리스트
이 그룹 소속 서버 인스턴스들이 존재할 zone 번호 리스트
String list Yes
  1. autoScalingGroupName

    • Auto Scaling Group의 이름
    • 그룹 식별자 역할을 합니다. 한 번 정해지면 그 뒤로는 불변입니다.
  2. desiredCapacity

    • 기대 서비스 능력
    • 그 그룹 소속으로 운영될 서버 인스턴스들의 수
  3. healthCheckGracePeriod

    • health check 보류 기간
    • 서버 인스턴스가 서비스에 투입된 이후 health check를 보류할 시간
    • healthCheckTypeCode 값이 로드밸런서(LOADB)이면 필수
  4. healthCheckTypeCode

    • Health check 유형 코드
    • 현재 사용 가능한 유형(type) 코드로는 서버(SVR)과 로드밸런서(LOADB)가 있습니다.
  5. launchConfigurationName

    • Launch Configuration 이름
    • 이 Auto Scaling Group 소속의 서버 인스턴스가 새로 생성될 때 사용되는 서버 관련 정보를 담고 있습니다.
  6. loadBalancerNameList

    • 로드밸런서 이름 리스트
    • 이 그룹 소속 서버가 생성되어 서비스에 투입될 때 등록될 로드밸런서 이름 리스트
  7. minSize

    • Auto Scaling Group의 최소 사이즈
  8. maxSize

    • Auto Scaling Group의 최대 사이즈
  9. defaultCooldown

    • 디폴트 cooldown 시간
    • 지정하지 않으면 300초로 설정됨
  10. zoneNoList

    • Zone 번호 리스트
    • 이 그룹 소속 서버 인스턴스들이 존재할 zone 번호 리스트

응답 데이터 타입

아래에는 응답으로 받은 xml 문서의 최상위 태그(객체)의 데이터 타입 이름이 기재되어 있습니다. 그 데이터 타입에 대한 상세 명세는 [API 데이터 타입] 문서를 참고합니다.

  • createAutoScalingGroupResponse 타입

오류

다음 에러 코드는 이 액션(action)에서 특징적으로 발생하는 에러입니다. 이 특징적인 에러와 모든 action에서 공통적으로 발생하는 에러에 대한 상세한 설명은 3.2 장 ‘에러 정의’ 절을 참고합니다.

  • 50100 (AlreadyExists)

    생성하려는 Auto Scaling Group 이름과 동일한 그룹이 이미 존재하면 이 에러가 발생합니다.

  • 50130 (LimitExceeded)

    maxSize가 지정되어 있다면 그 값은 100보다 작거나 같아야 합니다. 그렇지 않으면 상기 에러가 발생합니다.

    scaling group을 100개 이상 만들려고 하면, 상기 에러를 결과로 받게 됩니다.

사용 예시

  • 요청

    http://api.ncloud.com/autoscaling/?action=createAutoScalingGroup
    &autoScalingGroupName=asg-0224
    &desiredCapacity=0
    &launchConfigurationName=lc-1
    &maxSize=0&minSize=0
    &zoneNoList.1=2
    &zoneNoList.2=3
    &AUTHPARAMS
    
  • 응답

    <createAutoScalingGroupResponse>
    <requestId>015a4c61-c887-43f7-89ba-997ccdd75732</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <autoScalingGroupList>
    <autoScalingGroup>
    <autoScalingGroupName>asg-0224</autoScalingGroupName>
    <launchConfigurationName>lc-1</launchConfigurationName>
    <desiredCapacity>0</desiredCapacity>
    <minSize>0</minSize>
    <maxSize>0</maxSize>
    <loadBalancerInstanceSummeryList/>
    <healthCheckGracePeriod>0</healthCheckGracePeriod>
    <healthCheckType>
    <code>SVR</code>
    <codeName>Server</codeName>
    </healthCheckType>
    <createDate>2014-02-24T15:11:11+0900</createDate>
    <inAutoScalingGroupServerInstanceList/>
    <suspendedProcessList/>
    <zoneList>
    <zone>
    <zoneNo>2</zoneNo>
    <zoneName>zone2</zoneName>
    <zoneDescription>nang zone</zoneDescription>
    </zone>
    <zone>
    <zoneNo>3</zoneNo>
    <zoneName>zone3</zoneName>
    <zoneDescription>nang zone2</zoneDescription>
    </zone>
    </zoneList>
    </autoScalingGroup>
    </autoScalingGroupList>
    </createAutoScalingGroupResponse>
    

createLaunchConfiguration

설명

Launch Configuration은 Auto Scaling이 클라우드 서버 인스턴스를 생성하여 서비스에 투입하기 위해 사용되는 템플릿(template)입니다. 그 템플릿은 Auto Scaling이 서버 인스턴스를 생성하기 위한 모든 정보를 포함하고 있습니다. Launch Configuration 속성은 한 번 생성되면 이후 변경이 안됩니다.

요청 파라미터

모든 action에서 사용되는 공통 파라미터에 대한 상세 설명은 [서버-로드밸런서 API reference] 문서의 제 1장(제목: API 개요)을 찾아 보세요.

파라미터 이름 간략 설명 타입 제약 필수 여부
launchConfigurationName Launch Configuration 이름 String 최소 길이 1바이트, 최대 길이 255바이트
이름은 영어 소문자, 숫자와 하이픈(‘-‘)으로 이루어져야 합니다
단, 첫글자는 영문자이고, 마지막 문자는 영문자 또는 숫자여야 합니다.
Yes
serverImageProductCode 서버 이미지에 설치된 SW(OS 포함)의 상품 코드 String 최소 길이 1바이트, 최대 길이 20바이트 Conditional
serverProductCode 서버 HW spec과 관련된 서버 상품 코드 String 최소 길이 1바이트, 최대 길이 20바이트 No
memberServerImageNo 회원이 직접 만든 내 서버 이미지 번호 String Conditional
accessControlGroupConfigurationNoList ACG 설정 번호 String list 중복 불가 No
loginKeyName 로그인 키 이름 String 최소 길이 3바이트, 최대 길이 30바이트 No
userData 사용자 데이터 String 최소 길이 0바이트, 최대 길이 21847바이트 No
  1. launchConfigurationName

    • Launch Configuration의 이름
    • 식별자 역할을 합니다.
  2. serverImageProductCode

    • 서버 이미지에 설치된 SW(OS 포함)의 상품 코드.
    • 파라미터 memberServerImageNo와 serverImageProductCode 둘 중 하나는 지정되어 있어야 합니다. 그러나 둘 다 지정되어서는 안됩니다.
  3. serverProductCode

    • 서버 HW spec과 관련된 서버 상품 코드
  4. memberServerImageNo

    • 회원이 직접 만든 내 서버 이미지 번호.
    • 파라미터 memberServerImageNo와 serverImageProductCode 둘 중 하나는 지정되어 있어야 합니다. 그러나 둘 다 지정되어서는 안됩니다.
  5. accessControlGroupConfigurationNoList

    • ACG 설정 번호
    • 지정하지 않으면, 디폴트 ACG가 지정됩니다.
  6. loginKeyName

    • 로그인 키 이름
    • 지정되어 있지 않으면 사용자가 최근에 만든 로그인 키 이름이 지정됩니다.
  7. userData

    • 사용자 데이터
    • BASE64 encoding 문자열만 허용
    • 서버 인스턴스가 첫 부팅을 할 때, BASE64 encoding된 문자열을 decoding하여 평문이 된 문자열로 구성된 스크립트 파일이 실행됩니다.

응답 데이터 타입

아래에는 응답으로 받은 xml 문서의 최상위 태그(객체)의 데이터 타입 이름이 기재되어 있습니다. 그 데이터 타입에 대한 상세 명세는 [API 데이터 타입] 문서를 참고합니다.

  • createLaunchConfigurationResponse 타입

오류

다음 에러 코드는 이 액션(action)에서 특징적으로 발생하는 에러입니다. 이 특징적인 에러와 모든 action에서 공통적으로 발생하는 에러에 대한 상세한 설명은 3.2 장 ‘에러 정의’ 절을 참고합니다.

  • 50100 (AlreadyExists)

    생성하려던 Launch Configuration 이름과 동일한 것이 이미 존재합니다.

  • 50130 (LimitExceeded)

    하나의 고객이 100개 이상의 Launch Configuration을 생성하면 이 에러 코드를 결과로 받습니다.

  • 50110 (InvalidParameterCombination)

    파라미터 memberServerImageNo와 serverImageProductCode가 둘 다 지정되면 이 에러 코드를 결과로 받습니다.

사용 예시

  • 요청

    http://api.ncloud.com/autoscaling/?action=createLaunchConfiguration&launchConfigurationName=lc-0228&serverImageProductCode=SPSW0LINUX000009&AUTHPARAMS
    
  • 응답

    <createLaunchConfigurationResponse>
    <requestId>19fff23d-d5cd-49fd-8a0a-986ae02bf660</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <launchConfigurationList>
    <launchConfiguration>
    <launchConfigurationName>lc-0228</launchConfigurationName>
    <serverImageProductCode>SPSW0LINUX000009</serverImageProductCode>
    <serverProductCode>SPSVRSTAND000043</serverProductCode>
    <memberServerImageNo/>
    <loginKeyName>hkey-0217</loginKeyName>
    <createDate>2014-02-28T17:11:36+0900</createDate>
    <userData/>
    </launchConfiguration>
    </launchConfigurationList>
    </createLaunchConfigurationResponse>
    

deleteAutoScalingGroup

설명

지정된 Auto Scaling Group을 삭제합니다. 그룹 소속 서버 인스턴스가 없을 때, 그리고 아무런 scaling action이 진행중이지 않을 때만 가능합니다.

요청 파라미터

모든 action에서 사용되는 공통 파라미터에 대한 상세 설명은 [서버-로드밸런서 API reference] 문서의 제 1장(제목: API 개요)을 찾아 보세요.

파라미터 이름 간략 설명 타입 제약 필수 여부
autoScalingGroupName 삭제할 Auto Scaling Group의 이름 String 최소 길이 1바이트, 최대 길이 255바이트 Yes
  1. autoScalingGroupName
    • 삭제할 Auto Scaling Group의 이름

응답 데이터 타입

아래에는 응답으로 받은 xml 문서의 최상위 태그(객체)의 데이터 타입 이름이 기재되어 있습니다. 그 데이터 타입에 대한 상세 명세는 [API 데이터 타입] 문서를 참고합니다.

  • deleteAutoScalingGroupResponse 타입

오류

다음 에러 코드는 이 액션(action)에서 특징적으로 발생하는 에러입니다. 이 특징적인 에러와 모든 action에서 공통적으로 발생하는 에러에 대한 상세한 설명은 3.2 장 ‘에러 정의’ 절을 참고합니다.

  • 50150 (ResourceInUse)

    삭제하려는 Auto Scaling Group에 스케줄이 걸려 있습니다. 삭제가 가능하게 하기 위해서 먼저 그 그룹에 걸려 있는 모든 스케줄을 삭제해야 합니다.

  • 50160 (ScalingActivityInProgress)

사용 예시

  • 요청

    http://api.ncloud.com/autoscaling/?action=deleteAutoScalingGroup
    &autoScalingGroupName=asg-0228
    &AUTHPARAMS
    
  • 응답

    <deleteAutoScalingGroupResponse>
    <requestId>1027b8ed-1b5d-44ae-a25e-90c1244ca43b</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    </deleteAutoScalingGroupResponse>
    

deleteLaunchConfiguration

설명

Launch Configuration은 삭제될 때 어떠한 Auto Scaling Group에서도 사용되고 있는 상태여서는 안됩니다.

요청 파라미터

모든 action에서 사용되는 공통 파라미터에 대한 상세 설명은 [서버-로드밸런서 API reference] 문서의 제 1장(제목: API 개요)을 찾아 보세요.

파라미터 이름 간략 설명 타입 제약 필수 여부
launchConfigurationName 삭제될 Launch Configuration 이름 String 최소 길이 1바이트, 최대 길이 255바이트 Yes
  1. launchConfigurationName
    • 삭제할 Launch Configuration의 이름

응답 데이터 타입

아래에는 응답으로 받은 xml 문서의 최상위 태그(객체)의 데이터 타입 이름이 기재되어 있습니다. 그 데이터 타입에 대한 상세 명세는 [API 데이터 타입] 문서를 참고합니다.

  • deleteAutoScalingLaunchConfigurationResponse 타입

오류

다음 에러 코드는 이 액션(action)에서 특징적으로 발생하는 에러입니다. 이 특징적인 에러와 모든 action에서 공통적으로 발생하는 에러에 대한 상세한 설명은 3.2 장 ‘에러 정의’ 절을 참고합니다.

  • 50150 (ResourceInUse)

    삭제 대상인 Launch Configuration을 현재 Auto Scaling Group들이 참고하고 있어서 삭제할 수 없습니다.

사용 예시

  • 요청

    http://api.ncloud.com/autoscaling/?action=deleteAutoScalingLaunchConfiguration
    &launchConfigurationName=lc-0228
    &AUTHPARAMS
    
  • 응답

    <deleteAutoScalingLaunchConfigurationResponse>
    <requestId>81e1f723-550c-444b-bc39-467f61a2911a</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    </deleteAutoScalingLaunchConfigurationResponse>
    

deletePolicy

설명

Scaling 정책(policy)을 삭제합니다.

요청 파라미터

모든 action에서 사용되는 공통 파라미터에 대한 상세 설명은 [서버-로드밸런서 API reference] 문서의 제 1장(제목: API 개요)을 찾아 보세요.

파라미터 이름 간략 설명 타입 제약 필수 여부
autoScalingGroupName Auto Scaling Group의 이름 String 최소 길이 1바이트, 최대 길이 255바이트 Yes
policyName 삭제할 scaling 정책 이름 String 최소 길이 1바이트, 최대 길이 255바이트 Yes
  1. autoScalingGroupName

    • Auto Scaling Group의 이름
  2. policyName

    • 삭제할 scaling 정책 이름

응답 데이터 타입

아래에는 응답으로 받은 xml 문서의 최상위 태그(객체)의 데이터 타입 이름이 기재되어 있습니다. 그 데이터 타입에 대한 상세 명세는 [API 데이터 타입] 문서를 참고합니다.

  • deletePolicyResponse 타입

사용 예시

  • 요청

    http://api.ncloud.com/autoscaling/?action=deletePolicy&autoScalingGroupName=asg-0601&policyName=scale-out
    &AUTHPARAMS
    
  • 응답

    <deletePolicyResponse>
    <requestId>beb99f0c-9415-469f-8c1c6ac130a16515</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    </deletePolicyResponse>
    

deleteScheduledAction

설명

이전에 PutScheduledUpdateGroupAction에 의해 생성된 scaling action 스케줄을 삭제합니다.

요청 파라미터

모든 action에서 사용되는 공통 파라미터에 대한 상세 설명은 [서버-로드밸런서 API reference] 문서의 제 1장(제목: API 개요)을 찾아 보세요.

파라미터 이름 간략 설명 타입 제약 필수 여부
autoScalingGroupName Auto Scaling Group의 이름 String 최소 길이 1바이트, 최대 길이 255바이트 No
scheduledActionName 삭제할 scaling action 스케줄 이름 String 최소 길이 1바이트, 최대 길이 255바이트 Yes
  1. autoScalingGroupName

    • Auto Scaling Group의 이름
    • 지정되어 있으면 그 Auto Scaling Group에 속한 스케줄 중 scheduledActionName와 이름이 일치한 것만 삭제
  2. scheduledActionName

    • 삭제할 scaling action 스케줄 이름

응답 데이터 타입

아래에는 응답으로 받은 xml 문서의 최상위 태그(객체)의 데이터 타입 이름이 기재되어 있습니다. 그 데이터 타입에 대한 상세 명세는 [API 데이터 타입] 문서를 참고합니다.

  • deleteScheduledActionResponse 타입

사용 예시

  • 요청

    http://api.ncloud.com/autoscaling/?action=deleteScheduledAction
    &scheduledActionName=sa-1
    &AUTHPARAMS
    
  • 응답

    <deleteScheduledActionResponse>
    <requestId>1651a986-1de3-4a03-98ad-ae8c24fa25b7</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    </deleteScheduledActionResponse>
    

executePolicy

설명

지정된 scaling 정책(policy)를 수행합니다.

요청 파라미터

모든 action에서 사용되는 공통 파라미터에 대한 상세 설명은 [서버-로드밸런서 API reference] 문서의 제 1장(제목: API 개요)을 찾아 보세요.

파라미터 이름 간략 설명 타입 제약 필수 여부
policyName 수행할 정책 이름
스케일링 정책의 식별자
String 최소 길이 1바이트, 최대 길이 255바이트 Yes
autoScalingGroupName 정책이 수행될 Auto Scaling Group 이름 (식별자) String 최소 길이 1바이트, 최대 길이 255바이트 Yes
honorCooldown Cooldown 시간 준수 여부
디폴트 값은 false
Boolean No
  1. policyName

    • 정책 이름. 스케일링 정책의 식별자
  2. autoScalingGroupName

    • 이 정책이 수행될 Auto Scaling Group 이름 (식별자)
  3. honorCooldown

    • Cooldown 시간 준수 여부
    • 이 api를 호출했을 당시가 scaling action 도중이거나 cooldown 시간이면 이를 준수할 지 정합니다. true이면 준수하고 false이면 준수하지 않습니다.
    • 디폴트 값은 false. 즉 명시적으로 true로 지정하지 않으면 준수하지 않습니다.

응답 데이터 타입

아래에는 응답으로 받은 xml 문서의 최상위 태그(객체)의 데이터 타입 이름이 기재되어 있습니다. 그 데이터 타입에 대한 상세 명세는 [API 데이터 타입] 문서를 참고합니다.

  • executePolicyResponse 타입

오류

다음 에러 코드는 이 액션(action)에서 특징적으로 발생하는 에러입니다. 이 특징적인 에러와 모든 action에서 공통적으로 발생하는 에러에 대한 상세한 설명은 3.2 장 ‘에러 정의’ 절을 참고합니다.

  • 50120 (InvalidParameterValue)

    실행 대상 Auto Scaling Group이 scaling action 도중이거나 cooldown 시간일 때 honorCooldown을 true로 지정한 상태에서 이 api를 호출하면 이 오류가 발생합니다.

사용 예시

  • 요청

    http://api.ncloud.com/autoscaling/?action=executePolicy
    &autoScalingGroupName=asg-0602b
    &honorCooldown=true
    &policyName=p-0602
    &AUTHPARAMS
    
  • 응답

    <executePolicyResponse>
    <requestId>0c811c22-cdd3-47e5-8d8b-434071de2e46</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    </executePolicyResponse>
    

getAdjustmentTypeList

설명

설정 가능한 정책(policy) 조정 유형들을 리스트 형태로 받습니다.

응답 데이터 타입

아래에는 응답으로 받은 xml 문서의 최상위 태그(객체)의 데이터 타입 이름이 기재되어 있습니다. 그 데이터 타입에 대한 상세 명세는 [API 데이터 타입] 문서를 참고합니다.

  • getAutoScalingPolicyListResponse 타입

사용 예시

  • 요청

    http://api.ncloud.com/autoscaling/?action=getAdjustmentTypeList
    &AUTHPARAMS
    
  • 응답

    <getAutoScalingPolicyListResponse>
    <getAdjustmentTypeListResponse>
    <requestId>9fc03056-b3c4-40c0-b52d-8538c1df8b9b</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>3</totalRows>
    <adjustmentTypeList>
    <adjustmentType><adjustmentType><code>CHANG</code><codeName>ChangeInCapacity</codeName></adjustmentType>
    </adjustmentType><adjustmentType><adjustmentType><code>EXACT</code><codeName>ExactCapacity</codeName></adjustmentType></adjustmentType>
    <adjustmentType><adjustmentType><code>PRCNT</code><codeName>PercentChangeInCapacity</codeName></adjustmentType></adjustmentType>
    </adjustmentTypeList>
    </getAdjustmentTypeListResponse>
    

getAutoScalingGroupList

설명

scaling group들에 대한 설명을 리스트 형태로 전달. Auto Scaling Group 이름이 지정되어 있지 않으면 사용자가 보유한 모든 Auto Scaling Group에 대한 설명을 리스트로 받고, 지정되어 있으면 지정된 Auto Scaling Group만의 설명을 리스트로 받습니다.

또한 페이지로 나누어 볼 수 있습니다. 사용자가 각 페이지 사이즈(항목 수)와 페이지 번호를 지정할 수 있습니다.

요청 파라미터

모든 action에서 사용되는 공통 파라미터에 대한 상세 설명은 [서버-로드밸런서 API reference] 문서의 제 1장(제목: API 개요)을 찾아 보세요.

파라미터 이름 간략 설명 타입 제약 필수 여부
autoScalingGroupNameList.N Auto Scaling Group의 이름 리스트 String list 각 항목은 최소 길이 1바이트, 최대 길이 255바이트 No
pageNo 페이지 번호 Integer 최소 길이 1 No
pageSize 페이지 사이즈 Integer No
sortedBy 리스트 정렬 기준 String No
sortingOrder 리스트 정렬 순서 String No
  1. autoScalingGroupNameList.N

    • Auto Scaling Group의 이름 리스트
  2. pageNo

    • 페이지 번호
  3. pageSize

    • 페이지 사이즈
  4. sortedBy

    • 리스트 정렬 기준
    • 유효한 값으로 오토스케일링그룹명(autoScalingGroupName)과 생성일시(createDate)가 있습니다.
    • 대소문자 구분은 없습니다.
    • Default 값은 오토스케일링그룹명(autoScalingGroupName)입니다.
  5. sortingOrder

    • 리스트 정렬 순서
    • 유효한 값으로 오름차순(ascending)과 내림차순(descending)이 있습니다.
    • 대소문자 구분은 없습니다.
    • 디폴트(Default) 값은 오름차순(ascending)입니다.

응답 데이터 타입

아래에는 응답으로 받은 xml 문서의 최상위 태그(객체)의 데이터 타입 이름이 기재되어 있습니다. 그 데이터 타입에 대한 상세 명세는 [API 데이터 타입] 문서를 참고합니다.

  • getAutoScalingGroupListResponse 타입

사용 예시

  • 요청

    http://api.ncloud.com/autoscaling/?action=getAutoScalingGroupList
    &autoScalingGroupNameList.1=asg-1
    &AUTHPARAMS
    
  • 응답

    <getAutoScalingGroupListResponse>
    <requestId>be42c6e2-9c59-4bbc-b9d4-42194a68077d</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <autoScalingGroupList>
    <autoScalingGroup>
    <autoScalingGroupName>asg-1</autoScalingGroupName>
    <launchConfigurationName>lc-1</launchConfigurationName>
    <desiredCapacity>0</desiredCapacity>
    <minSize>0</minSize>
    <maxSize>0</maxSize>
    <loadBalancerInstanceSummeryList>
    <loadBalancerInstanceSummery>
    <loadBalancerName>slb-1</loadBalancerName>
    </loadBalancerInstanceSummery>
    <loadBalancerInstanceSummery>
    <loadBalancerName>slb-2</loadBalancerName>
    </loadBalancerInstanceSummery>
    </loadBalancerInstanceSummeryList>
    <healthCheckGracePeriod>600</healthCheckGracePeriod>
    <healthCheckType>
    <code>SVR</code>
    <codeName>Server</codeName>
    </healthCheckType>
    <createDate>2014-02-13T17:24:19+0900</createDate>
    <inAutoScalingGroupServerInstanceList/>
    <suspendedProcessList/>
    <zoneList>
    <zone>
    <zoneNo>2</zoneNo>
    <zoneName>zone2</zoneName>
    <zoneDescription>nang zone</zoneDescription>
    </zone>
    <zone>
    <zoneNo>3</zoneNo>
    <zoneName>zone3</zoneName>
    <zoneDescription>nang zone2</zoneDescription>
    </zone>
    </zoneList>
    </autoScalingGroup>
    </autoScalingGroupList>
    </getAutoScalingGroupListResponse>
    

getAutoScalingPolicyList

설명

Auto Scaling 정책(policy) 들에 대한 설명을 리스트 형태로 받습니다.

요청 파라미터

모든 action에서 사용되는 공통 파라미터에 대한 상세 설명은 [서버-로드밸런서 API reference] 문서의 제 1장(제목: API 개요)을 찾아 보세요.

파라미터 이름 간략 설명 타입 제약 필수 여부
policyNameList.N 정책 이름(식별자) 리스트 String list 각 항목은 최소 길이 1바이트, 최대 길이 255바이트 No
autoScalingGroupName Auto Scaling Group의 이름 (식별자) String 각 항목은 최소 길이 1바이트, 최대 길이 255바이트 No
pageNo 페이지 번호 Integer 최소 길이 1 No
pageSize 페이지 사이즈 String No
  1. policyNameList.N

    • 정책 이름(식별자) 리스트
    • 지정되어 있지 않으면 사용자가 보유한 모든 정책 정보를 받습니다.
  2. autoScalingGroupName

    • Auto Scaling Group의 이름 (식별자)
    • 지정되어 있으면 그 그룹에 관한 정책만을 받고, 지정되어 있지 않으면 사용자가 가진 모든 그룹 관련한 정책 정보를 받습니다.
  3. pageNo

    • 페이지 번호
  4. pageSize

    • 페이지 사이즈

응답 데이터 타입

아래에는 응답으로 받은 xml 문서의 최상위 태그(객체)의 데이터 타입 이름이 기재되어 있습니다. 그 데이터 타입에 대한 상세 명세는 [API 데이터 타입] 문서를 참고합니다.

  • getAutoScalingPolicyListResponse 타입

사용 예시

  • 요청

    http://api.ncloud.com/autoscaling/?action=getAutoScalingPolicyList
    &autoScalingGroupName=asg-0602b
    &pageNo=1
    &pageSize=10
    &policyNameList.1=scale-out
    &policyNameList.2=scale-in
    &AUTHPARAMS
    
  • 응답

    <getAutoScalingPolicyListResponse>
    <requestId>b3b5947c-a4fd-4104-b619-ba472665d50c</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>2</totalRows>
    <scalingPolicyList>
    <scalingPolicy>
    <policyName>scale-in</policyName>
    <autoScalingGroupName>asg-0602b</autoScalingGroupName>
    <adjustmentType><code>CHANG</code><codeName>ChangeInCapacity</codeName></adjustmentType>
    <scalingAdjustment>-1</scalingAdjustment>
    </scalingPolicy>
    <scalingPolicy><policyName>scale-out</policyName>
    <autoScalingGroupName>asg-0602b</autoScalingGroupName>
    <adjustmentType><code>PRCNT</code><codeName>PercentChangeInCapacity</codeName></adjustmentType>
    <scalingAdjustment>50</scalingAdjustment><cooldown>600</cooldown>
    <minAdjustmentStep>2</minAdjustmentStep>
    </scalingPolicy>
    </scalingPolicyList>
    </getAutoScalingPolicyListResponse>
    

getAutoScalingActivityLogList

설명

과거 6주 동안의 모든 scaling action 로그를 결과로 받습니다. 진행 중인 action은 리스트 앞에 나타납니다.

또한 페이지로 나누어 볼 수 있습니다. 사용자가 각 페이지 사이즈(항목 수)와 페이지 번호를 지정할 수 있습니다.

요청 파라미터

모든 action에서 사용되는 공통 파라미터에 대한 상세 설명은 [서버-로드밸런서 API reference] 문서의 제 1장(제목: API 개요)을 찾아 보세요.

파라미터 이름 간략 설명 타입 제약 필수 여부
activityNoList.N Scaling action(activity) 식별 번호 String list 각 항목은 최소 길이 1바이트, 최대 길이 255바이트 No
autoScalingGroupName
pageNo 페이지 번호 Integer 최소 길이 1 No
pageSize 페이지 사이즈 String No
  1. activityNoList.N

    • Scaling action(activity) 식별 번호
  2. pageNo

    • 페이지 번호
  3. pageSize

    • 페이지 사이즈

응답 데이터 타입

아래에는 응답으로 받은 xml 문서의 최상위 태그(객체)의 데이터 타입 이름이 기재되어 있습니다. 그 데이터 타입에 대한 상세 명세는 [API 데이터 타입] 문서를 참고합니다.

  • getAutoScalingConfigurationLogListResponse 타입

사용 예시

  • 요청

    http://api.ncloud.com/autoscaling/?action=getAutoScalingActivityLogList
    &activityNoList.1=1939
    &activityNoList.2=1943
    &AUTHPARAMS
    
  • 응답

    <getAutoScalingActivityLogListResponse>
    <requestId>c9df714e-29b7-42dd-9a38-7ac2be68f191</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>2</totalRows>
    <activityLogList>
    <activityLog>
    <activityNo>1939</activityNo>
    <autoScalingGroupName>psw26-auto</autoScalingGroupName>
    <status>
    <code>INPRG</code>
    <codeName>IN_PROGRESS</codeName>
    </status>
    <statusMessage/>
    <actionCause>MAINTAIN_INSTANCE_LEVEL psw26-auto</actionCause>
    <description>MAINTAIN_INSTANCE_LEVEL psw26-auto</description>
    <details>{}</details>
    <startTime>2014-02-17T13:28:47+0900</startTime>
    </activityLog>
    <activityLog>
    <activityNo>1943</activityNo>
    <autoScalingGroupName>asg-1</autoScalingGroupName>
    <status>
    <code>SUCCS</code>
    <codeName>SUCCESSFUL</codeName>
    </status>
    <statusMessage/>
    <actionCause>updateAutoScalingGroup asg-1</actionCause>
    <description>updateAutoScalingGroup asg-1</description>
    <details>
    updateAutoScalingGroup {autoScalingGroupNo=273, autoScalingGroupName=asg-1, requestTypeCode=API, zoneNoList=null, launchConfigurationName=null, desiredCapacity=0, oldDesiredCapacity=1, healthCheckTypeCode=SVR, minSize=0, healthCheckGracePeriod=null, clientIp=10.64.49.152, launchConfigurationNo=293, maxSize=0, memberNo=212}
    </details>
    <startTime>2014-02-24T13:47:52+0900</startTime>
    <endTime>2014-02-24T13:52:55+0900</endTime>
    </activityLog>
    </activityLogList>
    </getAutoScalingActivityLogListResponse>
    

getLaunchConfigurationList

설명

Launch Configuration 들에 대한 설명을 리스트 형태로 전달. Launch Configuration 이름이 지정되어 있지 않으면 사용자가 보유한 모든 Launch Configuration들의 설명을 리스트로 받고, 지정되어 있으면 지정된 Launch Configuration만의 설명을 리스트로 받습니다.

또한 페이지로 나누어 볼 수 있습니다. 사용자가 각 페이지 사이즈(항목 수)와 페이지 번호를 지정할 수 있습니다.

요청 파라미터

모든 action에서 사용되는 공통 파라미터에 대한 상세 설명은 [서버-로드밸런서 API reference] 문서의 제 1장(제목: API 개요)을 참고하세요.

파라미터 이름 간략 설명 타입 제약 필수 여부
launchConfigurationNameList.N Launch Configuration의 이름 리스트 String list 각 항목은 최소 길이 1바이트, 최대 길이 255바이트 No
pageNo 페이지 번호 Integer 최소 길이 1 No
pageSize 페이지 사이즈 Integer No
sortedBy 리스트 정렬 기준 String No
sortingOrder 리스트 정렬 순서 String No
  1. launchConfigurationNameList.N

    • Launch Configuration의 이름 리스트
  2. pageNo

    • 페이지 번호
  3. pageSize

    • 페이지 사이즈
  4. sortedBy

    • 리스트 정렬 기준
    • 유효한 값으로 론치설정명(launchConfigurationName)과 생성일시(createDate)가 있습니다.
    • 대소문자 구분은 없습니다.
    • Default 값은 론치설정명(launchConfigurationName)입니다.
  5. sortingOrder

    • 리스트 정렬 순서
    • 유효한 값으로 오름차순(ascending)과 내림차순(descending)이 있습니다.
    • 대소문자 구분은 없습니다.
    • 디폴트(Default) 값은 오름차순(ascending)입니다.

응답 데이터 타입

아래에는 응답으로 받은 xml 문서의 최상위 태그(객체)의 데이터 타입 이름이 기재되어 있습니다. 그 데이터 타입에 대한 상세 명세는 [API 데이터 타입] 문서를 참고합니다.

  • getLaunchConfigurationListResponse 타입

사용 예시

  • 요청

    http://api.ncloud.com/autoscaling/?action=getLaunchConfigurationList
    &launchConfigurationNameList.1=lc-1
    &AUTHPARAMS
    
  • 응답

    <getLaunchConfigurationListResponse>
    <requestId>a58e727a-b259-481c-b530-d62ea512ec51</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <launchConfigurationList>
    <launchConfiguration>
    <launchConfigurationName>lc-1</launchConfigurationName>
    <serverImageProductCode>SPSW0LINUX000009</serverImageProductCode>
    <serverProductCode>SPSVRSTAND000043</serverProductCode>
    <memberServerImageNo/>
    <loginKeyName>yh-nang-test</loginKeyName>
    <createDate>2014-02-13T13:45:57+0900</createDate>
    <userData/>
    </launchConfiguration>
    </launchConfigurationList>
    </getLaunchConfigurationListResponse>
    

getScalingProcessTypeList

설명

resumeProcesses와 suspendProcesses 액션(action)에서 사용되는 Scaling 처리 유형을 결과로 받습니다.

응답 데이터 타입

아래에는 응답으로 받은 xml 문서의 최상위 태그(객체)의 데이터 타입 이름이 기재되어 있습니다. 그 데이터 타입에 대한 상세 명세는 [API 데이터 타입] 문서를 참고합니다.

  • getScalingProcessTypeListResponse 타입

사용 예시

  • 요청

    http://api.ncloud.com/autoscaling/?action=getScalingProcessTypeList
    &AUTHPARAMS
    
  • 응답

    <getScalingProcessTypeListResponse>
    <requestId>95f0a458-f3de-4094-99ea-15317b30657b</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>0</totalRows>
    <processList>
    <process>
    <process>
    <code>LANCH</code>
    <codeName>서버 인스턴스 생성</codeName>
    </process>
    </process>
    <process>
    <process>
    <code>TERMT</code>
    <codeName>서버 인스턴스 반납</codeName>
    </process>
    </process>
    <process>
    <process>
    <code>HTHCK</code>
    <codeName>Health check</codeName>
    </process>
    </process>
    <process>
    <process>
    <code>RPUNH</code>
    <codeName>헬스에 문제 있는 서버 인스턴스 교체</codeName>
    </process>
    </process>
    <process>
    <process>
    <code>ZNRBL</code>
    <codeName>zone별 서버 인스턴스 수 리밸런싱</codeName>
    </process>
    </process>
    <process>
    <process>
    <code>SCACT</code>
    <codeName>Scheduled action</codeName>
    </process>
    </process>
    <process>
    <process>
    <code>ADTLB</code>
    <codeName>서버 인스턴스를 로드밸런서에 추가</codeName>
    </process>
    </process>
    <process>
    <process>
    <code>ALMNO</code>
    <codeName>알람 통보</codeName>
    </process>
    </process>
    </processList>
    </getScalingProcessTypeListResponse>
    

getScheduledActionList

설명

아직 실행되지 않은 사용자의 모든 Scaling action 스케줄을 나열합니다. 이미 실행된 action 기록은 getAutoScalingActivityLogList을 호출해서 볼 수 있습니다.

또한 페이지로 나누어 볼 수 있습니다. 사용자가 각 페이지 사이즈(항목 수)와 페이지 번호를 지정할 수 있습니다.

요청 파라미터

모든 action에서 사용되는 공통 파라미터에 대한 상세 설명은 [서버-로드밸런서 API reference] 문서의 제 1장(제목: API 개요)을 참고하세요.

파라미터 이름 간략 설명 타입 제약 필수 여부
autoScalingGroupName Auto Scaling Group 이름 String 최소 길이 1바이트, 최대 길이 255바이트 No
scheduledActionNameList.N 결과로 받을 scaling action 스케줄의 이름 리스트 String list 각 항목은 최소 길이 1바이트, 최대 길이 255바이트 No
startTime 결과로 받을 스케줄 중 시작 시간이 가장 이른 것 Date No
endTime 결과로 받을 스케줄 중 시작 시간이 가장 늦은 것 Date No
pageNo 페이지 번호 Integer 최소 길이 1 No
pageSize 페이지 사이즈 Integer No
sortedBy 리스트 정렬 기준 String No
sortingOrder 리스트 정렬 순서 String No
  1. autoScalingGroupName

    • Auto Scaling Group 이름
  2. scheduledActionNameList.N

    • 결과로 받을 scaling action 스케줄의 이름 리스트
  3. startTime

    • 이 날짜/시간 포맷에 대한 자세한 설명은 [Auto Scaling API 개발자 가이드] 문서를 참고합니다.
    • 예를 들어 ‘2014-02-28T20:30:00+0900’
  4. endTime

    • 이 날짜/시간 포맷에 대한 자세한 설명은 [Auto Scaling API 개발자 가이드] 문서를 참고합니다.
    • 예를 들어 ‘2014-02-28T20:30:00+0900’
  5. pageNo

    • 페이지 번호
  6. pageSize

    • 페이지 사이즈
  7. sortedBy

    • 리스트 정렬 기준
    • 유효한 값으로 스케줄액션명(scheduledActionName)과 생성일시(createDate)가 있습니다.
    • 대소문자 구분은 없습니다.
    • Default 값은 스케줄액션명(scheduledActionName)입니다.
  8. sortingOrder

    • 리스트 정렬 순서
    • 유효한 값으로 오름차순(ascending)과 내림차순(descending)이 있습니다.
    • 대소문자 구분은 없습니다.
    • 디폴트(Default) 값은 오름차순(ascending)입니다.

응답 데이터 타입

아래에는 응답으로 받은 xml 문서의 최상위 태그(객체)의 데이터 타입 이름이 기재되어 있습니다. 그 데이터 타입에 대한 상세 명세는 [API 데이터 타입] 문서를 참고합니다.

  • getScheduledActionListResponse 타입

오류

다음 에러 코드는 이 액션(action)에서 특징적으로 발생하는 에러입니다. 이 특징적인 에러와 모든 action에서 공통적으로 발생하는 에러에 대한 상세한 설명은 3.2 장 ‘에러 정의’ 절을 참고합니다.

사용 예시

  • 요청

    http://api.ncloud.com/autoscaling/?action=getScheduledActionList
    &autoScalingGroupName=asg-1
    &startTime=2014-03-01T20%3A00%3A00%2B0900
    &AUTHPARAMS
    
  • 응답

    <getScheduledActionListResponse>
    <requestId>4cea4b3c-1c15-4598-8188-37a413c74b2c</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>2</totalRows>
    <scheduledUpdateGroupActionList>
    <scheduledUpdateGroupAction>
    <autoScalingGroupName>asg-1</autoScalingGroupName>
    <scheduledActionName>sa-0228-4</scheduledActionName>
    <minSize>0</minSize>
    <startTime>2014-03-10T00:00:00+0900</startTime>
    <endTime>2014-03-10T00:00:00+0900</endTime>
    <recurrenceInKST>0 0 10 * *</recurrenceInKST>
    </scheduledUpdateGroupAction>
    <scheduledUpdateGroupAction>
    <autoScalingGroupName>asg-1</autoScalingGroupName>
    <scheduledActionName>sa-0228-5</scheduledActionName>
    <minSize>0</minSize>
    <startTime>2014-03-10T05:00:00+0900</startTime>
    <endTime>2014-03-10T05:00:00+0900</endTime>
    <recurrenceInKST>0 5 10 * *</recurrenceInKST>
    </scheduledUpdateGroupAction>
    </scheduledUpdateGroupActionList>
    </getScheduledActionListResponse>
    

putScalingPolicy

설명

Scaling 정책(policy)을 생성하거나 변경합니다. 정책 수행을 요청하면 설정된 정책에 따라 scale-in 또는 scale-out action을 수행합니다.

요청 파라미터

모든 action에서 사용되는 공통 파라미터에 대한 상세 설명은 [서버-로드밸런서 API reference] 문서의 제 1장(제목: API 개요)을 참고하세요.

파라미터 이름 간략 설명 타입 제약 필수 여부
policyName 정책 이름
스케일링 정책의 식별자
String 최소 길이 1바이트, 최대 길이 255바이트
이름은 영어 소문자, 숫자와 하이픈(‘-‘)으로 이루어져야 합니다
단, 첫글자는 영문자이고, 마지막 문자는 영문자 또는 숫자여야 합니다
Yes
autoScalingGroupName 정책이 수행될 Auto Scaling Group 이름 (식별자) String 최소 길이 1바이트, 최대 길이 255바이트 Yes
adjustmentTypeCode Group의 capacity를 조정하는 유형 코드 String 최소 길이 1바이트, 최대 길이 255바이트 Yes
scalingAdjustment 스케일링을 위한 Group capacity 조정 값 Integer Yes
cooldown 쿨다운 기간
단위는 초(sec)
scaling 활동(action) 종료 후 이 쿨다운 기간에 alarm을 통보 받고
Integer 0 이상의 정수 No
minAdjustmentStep 최소 조정 폭(step) Integer 1 이상의 정수 No
  1. policyName

    • 정책 이름. 스케일링 정책의 식별자
    • 특정 Auto Scaling Group 소속이며 그 범위 안에서는 이 이름이 중복 생성될 수 없습니다.
    • 이 api를 호출했을 때 지정된 Auto Scaling Group의 범위 안에서 정책 이름이 없다면 생성을 하고 이미 존재한다면 그 내용을 변경합니다.
    • 하나의 Auto Scaling Group당 최대 10개의 정책을 생성할 수 있습니다.
  2. autoScalingGroupName

    • 정책이 수행될 Auto Scaling Group 이름 (식별자).
  3. adjustmentTypeCode

    • Group의 capacity를 조정하는 유형 코드
    • 다음과 같이 3개의 코드가 유효합니다. (괄호 안이 입력 가능한 코드 값)
    • ChangeInCapacity(CHANG)
    • ExactCapacity(EXACT)
    • PercentChangeInCapacity(PRCNT)
    • 상기 코드에 대한 설명은 다음과 같습니다.
    • ChangeInCapacity(CHANG): 아래 수식과 같이 capacity가 지정된 값만큼 변경됩니다.

      (new desired capacity) = (current actual capacity) + (scalingAdjustment of ChangeInCapacity type)
      

      예를 들어, 현재 실제(actual) capacity가 5인데, scalingAdjustment 값이 3이라면, desired capacity는 8로 변경됩니다.

    • ExactCapacity(EXACT): capacity가 지정된 값으로 변경됩니다

      (new desired capacity) = (scalingAdjustment of ExactCapacity type)
      

      예를 들어, 현재 실제(actual) capacity가 5인데, scalingAdjustment 값이 9라면, desired capacity는 9로 변경됩니다.

    • PercentChangeInCapacity(PRCNT): capacity가 지정된 perecent 값만큼 변경됩니다

      (new desired capacity) = (current actual capacity) + (current actual capacity) X (scalingAdjustment of PercentChangeInCapacity type) / 100
      

      예를 들어, 현재 실제(actual) capacity가 5인데, scalingAdjustment 값이 100이라면, Desired Capacity는 10으로 변경됩니다.

    • adjustmentTypeCode 값이 ChangeInCapacity(CHANG) 또는 PercentChangeInCapacity(PRCNT) 유형일 때, 새로운 Desired Capacity는 현재의 Desired Capacity가 아닌 현재의 실제(actual) capacity를 기반으로 계산이 됩니다.

  4. scalingAdjustment

    • 스케일링을 위한 Group capacity 조정 값
    • adjustmentTypeCode 값이 ChangeInCapacity(CHANG) 또는 PercentChangeInCapacity(PRCNT) 유형일 때, scalingAdjustment가 양수이면 capacity가 증가해서 scale-out이 되고, scalingAdjustment가 음수이면 capacity가 감소해서 scale-in이 됩니다.
    • PercentChangeInCapacity(PRCNT) 유형의 scalingAdjustment의 최소 값은 -100입니다.
  5. cooldown

    • scaling action 종료 이후 cooldown 시간 동안은 alarm을 통보 받아도 무시합니다.
  6. minAdjustmentStep

    • 최소 조정 폭(step)
    • adjustmentTypeCode 유형이 PercentChangeInCapacity(PRCNT)일 때만 지정 가능합니다 (따라서 지정 안 하는 것도 가능). 다른 유형 값일 경우는 지정이 안됩니다.
    • PercentChangeInCapacity(PRCNT) 유형일 때 scalingAdjustment에 의한 변경량(change)이 minAdjustmentStep보다 작으면 변경량을 minAdjustmentStep으로 설정합니다.

응답 데이터 타입

아래에는 응답으로 받은 xml 문서의 최상위 태그(객체)의 데이터 타입 이름이 기재되어 있습니다. 그 데이터 타입에 대한 상세 명세는 [API 데이터 타입] 문서를 참고합니다.

  • putScalingPolicyResponse 타입

오류

다음 에러 코드는 이 액션(action)에서 특징적으로 발생하는 에러입니다. 이 특징적인 에러와 모든 action에서 공통적으로 발생하는 에러에 대한 상세한 설명은 3.2 장 ‘에러 정의’ 절을 참고합니다.

  • 50130 (LimitExceeded)

    하나의 Auto Scaling Group당 최대 10개의 정책을 생성할 수 있습니다.

사용 예시

  • 요청

    http://api.ncloud.com/autoscaling/?action=putScalingPolicy
    &adjustmentTypeCode=PRCNT
    &autoScalingGroupName=asg-0602b
    &cooldown=100
    &minAdjustmentStep=2
    &policyName=p-0602
    &scalingAdjustment=40
    &AUTHPARAMS
    
  • 응답

    <putScalingPolicyResponse>
    <requestId>492648d9-9016-4b29-9773-bc457c2bdefd</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    </putScalingPolicyResponse>
    

putScheduledUpdateGroupAction

설명

지정된 Auto Scaling Group을 위한 scaling action 스케줄을 생성 또는 갱신합니다. 이 액션(action)을 호출할 때, 동일한 이름의 스케줄 이름이 이미 있으면 그 스케줄을 변경하고, 아니면 스케줄을 생성합니다. 스케줄의 종류는 일회성 스케줄과 반복 스케줄로 나뉩니다. 일회성 스케줄을 생성하고 싶으면 start time은 지정하고 반복(recurrence) 설정은 하지 않으면 됩니다. 반복 스케줄을 설정하고 싶으면 반복 설정을 하면 됩니다.

호출할 때 파라미터 중 Min size, Desired Capacity와 max size 이 셋은 적어도 하나는 지정되어 있어야 합니다. 스케줄이 실행될 때 전술한 세 파라미터 중 지정 된 파라미터의 Auto Scaling Group의 해당 속성을 변경합니다. 스케줄에 의해 변경된 Auto Scaling Group의 Min size, Desired Capacity와 max size는 변경 이후에도 Min size <= Desired Capacity <= max size의 대소 관계를 유지해야 합니다. 그렇지 않으면 스케줄 적용이 실패해서 효과가 발생하지 않습니다.

요청 파라미터

모든 action에서 사용되는 공통 파라미터에 대한 상세 설명은 [서버-로드밸런서 API reference] 문서의 제 1장(제목: API 개요)을 참고하세요.

파라미터 이름 간략 설명 타입 제약 필수 여부
autoScalingGroupName 스케줄이 적용될 Auto Scaling Group 이름 String 최소 길이 1바이트, 최대 길이 255바이트
이름은 영어 소문자, 숫자와 하이픈(‘-‘)으로 이루어져야 합니다.
단, 첫글자는 영문자이고, 마지막 문자는 영문자 또는 숫자여야 합니다
Yes
desiredCapacity 지정된 그룹에서 운영되어야 할 서버 인스턴스의 수 String 최소 길이 1바이트, 최대 길이 20바이트 Conditional
endTime 종료 시각 String 최소 길이 1바이트, 최대 길이 20바이트 No
maxSize 지정된 그룹의 최대 사이즈 String Conditional
minSize 지정된 그룹의 최소 사이즈 String list 중복 불가 No
recurrenceInKST scaling action을 반복 시작하도록 설정한 스케줄의 시간
지정된 시각은 한국 시간존 기준입니다
String 최소 길이 3바이트, 최대 길이 30바이트 No
scheduledActionName Scaling action 스케줄 이름 String 최소 길이 0바이트, 최대 길이 21847바이트 Yes
startTime 시작 시각 Date Conditional
  1. autoScalingGroupName

    • 스케줄이 적용될 Auto Scaling Group 이름
  2. desiredCapacity

    • 지정된 그룹에서 운영되어야 할 서버 인스턴스의 수
  3. endTime

    • 종료 시각
    • 반복 스케줄 설정(recurrenceInKST)과 이 값이 동시에 지정되어 있다면, 이 종료 시각이 지나면 반복 스케줄은 자동 삭제되어 그 스케줄에 따른 scaling action이 일어나지 않게 됩니다.
    • 반복 스케줄이 설정이 지정되어 있지 않은 일회성 스케줄을 잡을 때도 종료 시각을 지정할 수 있으나 어떠한 효과(effect)도 없습니다.
    • 시작 시각이 지정되어 있다면, 종료 시각은 시작 시각보다 뒤에 있거나 같아야 합니다.
    • 종료 시각의 data type인 Date 타입의 날짜 시간 포맷에 대한 자세한 설명은 [Auto Scaling API 개발자 가이드] 문서의 [Auto Scaling에서 사용되는 Date 데이터 타입의 날짜 시간 포맷] 장에 있습니다.
    • Date 타입 데이터의 일례는 다음과 같습니다. ‘2014-02-28T20:30:00+0900’
  4. maxSize

    • 100보다 작거나 같아야 합니다.
  5. minSize

    • 지정된 그룹의 최소 사이즈
  6. recurrenceInKST

    • 반복 스케줄 설정
    • 설정 형식은 crontab 설정 방식입니다. 분(minute)과 시(hour)와 날짜(day of month), 달(month) 및 요일(day of week) 필드를 공백문자를 분리자로 해서 기재하면 됩니다.
    • 분(minute)과 시(hour)와 날짜(day of month), 달(month) 및 요일(day of week) 필드로 입력될 수 있는 유효한 값은 각각 0-59, 0-23, 1-31, 1-12(또는 달 영어 이름), 0-7(0 또는 7이 일요일, 또는 요일 영어 이름)입니다
    • 필드 값으로 asterisk('*')를 넣을 수 있는데 있는 처음 값부터 마지막 값 모두를 의미합니다
    • 아래는 그 예시입니다. (예시에 있는 대괄호([])는 빼고 하나의 라인으로 입력할 것)
    • 예시 1: 매시 정각: [0 * * * *]
    • 예시 2: 매주 토요일 16시 30분: [30 16 * * 6]
    • 예시 3: 매월 첫날 자정: [0 0 1 * *]
    • 예시 4: 매해 1월 1일 자정: [0 0 1 Jan *]
    • 추가적인 Crontab 설정 방법에 대한 설명은 crontab (5)에 대한 Linux man page를 보시면 됩니다.
    • 이 반복 스케줄 설정에서 지정된 시각은 시간대는 한국 표준 시간대(KST)로 봅니다. 한국 표준 시간대는 국제 표준 시간대보다 9시간 빠릅니다.
    • 액션(action)을 호출할 때 이 반복 스케줄 설정과 시작 시각 둘 중에 적어도 하나는 지정되어 있어야 합니다.
  7. scheduledActionName

    • Scaling action 스케줄 이름. 스케줄 식별자 역할을 합니다
    • 지정된 Auto Scaling Group 내에서는 유일한 이름이어야 합니다.
    • 이 액션(action)을 호출할 때, 동일한 이름의 스케줄 이름이 이미 있으면 그 스케줄을 변경하고, 아니면 스케줄을 생성합니다.
  8. startTime

    • 시작 시각
    • 반복 스케줄 설정(recurrenceInKST)과 이 시작 시각 둘 중에 적어도 하나는 지정되어 있어야 합니다. 시작 시각만 지정되어 있다면 그것은 일회성 스케줄입니다.
    • 반복 스케줄 설정이 지정되어 있지 않고, 이 값만 지정되어 있으면, 그 시각에 스케줄에 따라 scaling action이 시작됩니다. 그리고 그 일회성 스케줄은 삭제됩니다.
    • 반복 스케줄 설정과 이 값이 동시에 지정되어 있으면, 그 시작 시각에 이후에 반복 스케줄에 따라 scaling action이 이루어집니다.
    • 반복 스케줄 설정은 지정되어 있고 시작 시각은 지정되어 있지 않은 경우, 그 스케줄의 시작 시각은 반복 스케줄에 의해 처음 액션(action)이 이루어지는 시각으로 자동 설정됩니다.
    • 하나의 Auto Scaling Group 내에서의 각각의 스케줄은 시작 시각이 상이해야 합니다 (1초라도). 스케줄을 생성/갱신할 때, 동일한 시작 시각을 가진 다른 스케줄이 이미 존재한다면 실패합니다
    • 시작 시각의 data type인 Date 타입의 날짜 시간 포맷에 대한 자세한 설명은 [Auto Scaling API 개발자 가이드] 문서의 [Auto Scaling에서 사용되는 Date 데이터 타입의 날짜 시간 포맷] 장에 있습니다.
    • Date 타입 데이터의 일례는 다음과 같습니다. ‘2014-02-28T20:30:00+0900’

응답 데이터 타입

아래에는 응답으로 받은 xml 문서의 최상위 태그(객체)의 데이터 타입 이름이 기재되어 있습니다. 그 데이터 타입에 대한 상세 명세는 [API 데이터 타입] 문서를 참고합니다.

  • putScheduledUpdateGroupActionResponse 타입

오류

다음 에러 코드는 이 액션(action)에서 특징적으로 발생하는 에러입니다. 이 특징적인 에러와 모든 action에서 공통적으로 발생하는 에러에 대한 상세한 설명은 3.2 장 ‘에러 정의’ 절을 참고합니다.

  • 50100 (AlreadyExists)

    생성/갱신하려는 스케줄과 동일한 시작 시각을 가진 다른 스케줄이 존재한다면, 결과로 상기 에러를 받습니다.

  • 50130 (LimitExceeded)

    maxSize가 지정되어 있다면 그 값은 100보다 작거나 같아야 합니다. 그렇지 않으면 상기 에러가 발생합니다.

    스케줄을Auto Scaling Group당 100개 이상 지정하려 하면, 결과로 상기 에러를 받습니다.

사용 예시

  • 요청

    http://api.ncloud.com/autoscaling/?action=putScheduledUpdateGroupAction
    &autoScalingGroupName=asg-0212
    &desiredCapacity=3
    &scheduledActionName=sa-0303
    &startTime=2014-03-05T10%3A00%3A00%2B0900
    &AUTHPARAMS
    
  • 응답

    <putScheduledUpdateGroupActionResponse>
    <requestId>948b7bc1-47e6-4d5c-a71d-e85622ab16ef</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <scheduledUpdateGroupActionList>
    <scheduledUpdateGroupAction>
    <autoScalingGroupName>asg-0212</autoScalingGroupName>
    <scheduledActionName>sa-0303</scheduledActionName>
    <desiredCapacity>3</desiredCapacity>
    <startTime>2014-03-05T10:00:00+0900</startTime>
    <recurrenceInKST/>
    </scheduledUpdateGroupAction>
    </scheduledUpdateGroupActionList>
    </putScheduledUpdateGroupActionResponse>
    

resumeProcesses

설명

지정된 Auto Scaling Group에 대한 scaling 프로세스를 재개(resume)합니다.

요청 파라미터

모든 action에서 사용되는 공통 파라미터에 대한 상세 설명은 [서버-로드밸런서 API reference] 문서의 제 1장(제목: API 개요)을 참고하세요.

파라미터 이름 간략 설명 타입 제약 필수 여부
autoScalingGroupName Auto Scaling Group의 이름 String 최소 길이 1바이트, 최대 길이 255바이트 Yes
scalingProcessCodeList.N 재개해야 할 process 코드의 리스트 String list No
  1. autoScalingGroupName

    • Auto Scaling Group의 이름
  2. scalingProcessCodeList.N

    • 재개해야 할 process 코드의 리스트. 아래 항목이 유효한 값(괄호 안)입니다.
    • LAUNCH(LANCH)
    • TERMINATE(TERMT)
    • HEALTH_CHECK(HTHCK)
    • RELACE_UNHEALTHY(RPUNH)
    • ZONE_REBALANCE(ZNRBL)
    • SCHEDULED_ACTIONS(SCACT)
    • ADD_TO_LOAD_BALANCER(ADTLB)
    • ALARM_NOTIFICATION (ALMNO)
    • 각 값에 대한 설명은 [Auto Scaling API 개발자 가이드] 문서에 기재되어 있습니다. 만약 이 파라미터를 생략하면 상술한 모든 프로세스가 재개됩니다. 리스트에 동일 항목(프로세스)이 중복 지정될 수 없습니다.

응답 데이터 타입

아래에는 응답으로 받은 xml 문서의 최상위 태그(객체)의 데이터 타입 이름이 기재되어 있습니다. 그 데이터 타입에 대한 상세 명세는 [API 데이터 타입] 문서를 참고합니다.

  • resumeProcessesResponse 타입

사용 예시

  • 요청

    http://api.ncloud.com/autoscaling/?action=resumeProcesses
    &autoScalingGroupName=asg-1
    &AUTHPARAMS
    
  • 응답

    <resumeProcessesResponse>
    <requestId>c9c75402-73f6-4980-8131-f6b866de5477</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    </resumeProcessesResponse>
    

setDesiredCapacity

설명

지정된 Auto Scaling Group에 대한 desired capacity 설정

요청 파라미터

모든 action에서 사용되는 공통 파라미터에 대한 상세 설명은 [서버-로드밸런서 API reference] 문서의 제 1장(제목: API 개요)을 찾아 보세요.

파라미터 이름 간략 설명 타입 제약 필수 여부
autoScalingGroupName Auto Scaling Group 이름 String 최소 길이 1바이트, 최대 길이 255바이트 Yes
desiredCapacity 지정된 그룹의 새로운 Desired Capacity 설정 Integer No
  1. autoScalingGroupName

    • Auto Scaling Group 이름
  2. desiredCapacity

    • 지정된 그룹의 새로운 Desired Capacity 설정
    • 이 값이 Auto Scaling Group에 이미 설정되어 있는 기존 속성인 min size보다 작아서는 안되고, max size보다 커서는 안됩니다.

응답 데이터 타입

아래에는 응답으로 받은 xml 문서의 최상위 태그(객체)의 데이터 타입 이름이 기재되어 있습니다. 그 데이터 타입에 대한 상세 명세는 [API 데이터 타입] 문서를 참고합니다.

  • setDesiredCapacityResponse 타입

오류

다음 에러 코드는 이 액션(action)에서 특징적으로 발생하는 에러입니다. 이 특징적인 에러와 모든 action에서 공통적으로 발생하는 에러에 대한 상세한 설명은 3.2 장 ‘에러 정의’ 절을 참고합니다.

  • 50120 (InvalidParameterValue)

    desiredCapacity는 minSize보다 크거나 같고, maxSize보다 작거나 같아야 합니다. 그렇지 않으면 상기 에러가 발생합니다.

  • 50160 (ScalingActivityInProgress)

사용 예시

  • 요청

    http://api.ncloud.com/autoscaling/?action=setDesiredCapacity&autoScalingGroupName=asg-1&desiredCapacity=0&AUTHPARAMS
    
  • 응답

    <setDesiredCapacityResponse>
    <requestId>9b414c18-0b78-4e8f-a20d-4f95a16628be</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <autoScalingGroupList>
    <autoScalingGroup>
    <autoScalingGroupName>asg-1</autoScalingGroupName>
    <launchConfigurationName>lc-1</launchConfigurationName>
    <desiredCapacity>0</desiredCapacity>
    <minSize>0</minSize>
    <maxSize>0</maxSize>
    <loadBalancerInstanceSummeryList>
    <loadBalancerInstanceSummery>
    <loadBalancerName>slb-1</loadBalancerName>
    </loadBalancerInstanceSummery>
    <loadBalancerInstanceSummery>
    <loadBalancerName>slb-2</loadBalancerName>
    </loadBalancerInstanceSummery>
    </loadBalancerInstanceSummeryList>
    <healthCheckGracePeriod>600</healthCheckGracePeriod>
    <healthCheckType>
    <code>SVR</code>
    <codeName>Server</codeName>
    </healthCheckType>
    <createDate>2014-02-13T17:24:19+0900</createDate>
    <inAutoScalingGroupServerInstanceList/>
    <suspendedProcessList/>
    <zoneList>
    <zone>
    <zoneNo>2</zoneNo>
    <zoneName>zone2</zoneName>
    <zoneDescription>nang zone</zoneDescription>
    </zone>
    <zone>
    <zoneNo>3</zoneNo>
    <zoneName>zone3</zoneName>
    <zoneDescription>nang zone2</zoneDescription>
    </zone>
    </zoneList>
    </autoScalingGroup>
    </autoScalingGroupList>
    </setDesiredCapacityResponse>
    

setInstanceHealth

설명

사용자가 보유하는 Auto Scaling Group 소속의 서버 인스턴스의 헬스 상태를 설정

요청 파라미터

모든 action에서 사용되는 공통 파라미터에 대한 상세 설명은 [서버-로드밸런서 API reference] 문서의 제 1장(제목: API 개요)을 찾아 보세요.

파라미터 이름 간략 설명 타입 제약 필수 여부
healthStatusCode 헬스 상태 코드 String 최소 길이 1바이트, 최대 길이 5바이트 Yes
serverInstanceNo 서버 인스턴스의 식별 번호 String Yes
shouldRespectGracePeriod 헬스 체크 보류 기간 준수 여부 Boolean No
  1. healthStatusCode

    • 헬스 상태 코드
    • 유효 값으로 HEALTHY(HLTHY)와 UNHEALTHY(UNHTH)가 있습니다. 전술한 괄호 안의 코드 값을 사용할 것
    • 서버 인스턴스가 생성되고 나서 서비스에 투입된 이후에만 가능합니다.
  2. scalingProcessCodeList.N

    • 서버 인스턴스의 식별 번호
    • 고객님의 Auto Scaling Group 소속의 서버 인스턴스가 아니면 유효하지 않습니다.
  3. shouldRespectGracePeriod

    • 헬스 체크 보류 기간(healthCheckGracePeriod) 준수 여부
    • 서버 인스턴스가 생성되고 나서 서비스에 투입된 시각에서 healthCheckGracePeriod 기간이 지나지 않으면 unhealthy 상태로 변경하려 해도 적용되지 않습니다. 디폴트로 그 보류 기간을 준수합니다.
    • 그 값이 False이면, 그 보류 기간을 준수하지 않습니다.

응답 데이터 타입

아래에는 응답으로 받은 xml 문서의 최상위 태그(객체)의 데이터 타입 이름이 기재되어 있습니다. 그 데이터 타입에 대한 상세 명세는 [API 데이터 타입] 문서를 참고합니다.

  • setServerInstanceHealthResponse 타입

사용 예시

  • 요청

    http://api.ncloud.com/autoscaling/?action=setServerInstanceHealth
    &healthStatusCode=UNHTH
    &serverInstanceNo=68128
    &AUTHPARAMS
    
  • 응답

    <setServerInstanceHealthResponse>
    <requestId>2785401a-14e4-42b2-9e65-0f59b29424d4</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    </setServerInstanceHealthResponse>
    

suspendProcesses

설명

사용자가 보유하는 Auto Scaling Group 소속의 서버 인스턴스의 헬스 상태를 설정

요청 파라미터

모든 action에서 사용되는 공통 파라미터에 대한 상세 설명은 [서버-로드밸런서 API reference] 문서의 제 1장(제목: API 개요)을 참고하세요.

파라미터 이름 간략 설명 타입 제약 필수 여부
autoScalingGroupName Auto Scaling Group 이름 String 최소 길이 1바이트, 최대 길이 255바이트 Yes
scalingProcessCodeList.N 재개해야 할 process 코드의 리스트 String list No
  1. autoScalingGroupName

    • Auto Scaling Group 이름
  2. scalingProcessCodeList.N

    • 보류할 process 코드의 리스트. 아래 항목이 유효한 값(괄호 안)입니다.
    • LAUNCH (LANCH)
    • TERMINATE (TERMT)
    • HEALTH_CHECK (HTHCK)
    • RELACE_UNHEALTHY (RPUNH)
    • ZONE_REBALANCE (ZNRBL)
    • SCHEDULED_ACTIONS (SCACT)
    • ADD_TO_LOAD_BALANCER (ADTLB)
    • ALARM_NOTIFICATION (ALMNO)
    • 각 값에 대한 설명은 [Auto Scaling API 개발자 가이드] 문서에 기재되어 있습니다. 만약 이 파라미터를 생략하면 상술한 모든 프로세스가 보류됩니다. 리스트에 동일 항목(프로세스)이 중복 지정될 수 없습니다.

응답 데이터 타입

아래에는 응답으로 받은 xml 문서의 최상위 태그(객체)의 데이터 타입 이름이 기재되어 있습니다. 그 데이터 타입에 대한 상세 명세는 [API 데이터 타입] 문서를 참고합니다.

  • suspendProcessesResponse 타입

사용 예시

  • 요청

    http://api.ncloud.com/autoscaling/?action=suspendProcesses
    &autoScalingGroupName=asg-1
    &AUTHPARAMS
    
  • 응답

    <suspendProcessesResponse>
    <requestId>61964cd5-e29d-4d38-b0c8-5e5009c66b7b</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    </suspendProcessesResponse>
    

terminateInstanceInAutoScalingGroup

설명

지정된 서버 인스턴스 반납. 서버 인스턴스 삭제와 동시에 그룹 사이즈를 하나(one) 감소하게 선택할 수 있습니다.

요청 파라미터

모든 action에서 사용되는 공통 파라미터에 대한 상세 설명은 [서버-로드밸런서 API reference] 문서의 제 1장(제목: API 개요)을 참고하세요.

파라미터 이름 간략 설명 타입 제약 필수 여부
serverInstanceNo 삭제할 서버 인스턴스의 식별 번호 String Yes
shouldDecrementDesiredCapacity 서버 인스턴스 삭제와 동시에 소속 Auto Scaling Group의 size를 하나(one) 감소시킬지 여부 Boolean Yes
  1. serverInstanceNo

    • 삭제할 서버 인스턴스의 식별 번호
    • 서버 인스턴스가 Auto Scaling Group에 속하지 않다면 유효하지 않습니다.
  2. shouldDecrementDesiredCapacity

    • 서버 인스턴스 삭제와 동시에 소속 Auto Scaling Group의 size를 하나(one) 감소시킬지 여부
    • 감소시키려면 true이고, 아니면 false
    • 이 값이 true이면 그룹 사이즈가 (기존 그룹 사이즈 minus 1)이 됩니다.

응답 데이터 타입

아래에는 응답으로 받은 xml 문서의 최상위 태그(객체)의 데이터 타입 이름이 기재되어 있습니다. 그 데이터 타입에 대한 상세 명세는 [API 데이터 타입] 문서를 참고합니다.

  • terminateInstanceInAutoScalingGroup 타입

오류

다음 에러 코드는 이 액션(action)에서 특징적으로 발생하는 에러입니다. 이 특징적인 에러와 모든 action에서 공통적으로 발생하는 에러에 대한 상세한 설명은 3.2 장 ‘에러 정의’ 절을 참고합니다.

  • 50160 (ScalingActivityInProgress)

사용 예시

  • 요청

    http://api.ncloud.com/autoscaling/?action=terminateServerInstanceInAutoScalingGroup
    &serverInstanceNo=68124
    &shouldDecrementDesiredCapacity=false
    &AUTHPARAMS
    
  • 응답

    <terminateServerInstanceInAutoScalingGroupResponse>
    <requestId>1d7573fd-d321-400b-82bd-8a3a9692b5b6</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    </terminateServerInstanceInAutoScalingGroupResponse>
    

updateAutoScalingGroup

설명

지정된 Auto Scaling Group을 갱신합니다. 지정된 파라미터에 해당하는 속성만 그 값이 변경되고, 전달되지 않은 파라미터에 해당하는 속성은 기존 값 그대로 남게 됩니다. 이 액션(action) 호출에 의해 minSize, desiredCapacity또는 maxSize가 변경되어도 그 대소 관계는 계속 maxSize >= desiredCapacity >= minSize가 유지되어여야 합니다. zoneNoList가 변하면 zone rebalancing이 발생합니다.

이 액션(action) 호출로 새로운 Launch Configuration이 지정되면, 그 이후 서버 인스턴스가 생성될 때 효과가 나타납니다. Auto Scaling Group이 현재 scaling action이 이루어지고 있는 상태에서 호출하면 에러(코드 50160)가 납니다.

  • minSize는 지정되었으나 desiredCapacity가 지정되어 있지 않을 때, 새로운 minSize 값이 Auto Scaling Group의 현재 사이즈보다 크다면, 암시적으로 setDesiredCapacity가 호출되어서, 그룹 사이즈가 새로운 minSize로 설정됩니다

  • maxSize는 지정되었으나 desiredCapacity가 지정되어 있지 않을 때, 새로운 maxSize 값이 Auto Scaling Group의 현재 사이즈보다 작다면, 암시적으로 setDesiredCapacity가 호출되어서, 그룹 사이즈가 새로운 maxSize로 설정됩니다

  • 요청할 때 전달되지 않은 선택적 파라미터 모두 기존 값으로 남게 됩니다. 아무런 선택적 파라미터가 전달되지 않으면 아무 속성 값이 바뀌지 않습니다. (에러는 나지 않습니다.)

요청 파라미터

모든 action에서 사용되는 공통 파라미터에 대한 상세 설명은 [서버-로드밸런서 API reference] 문서의 제 1장(제목: API 개요)을 참고하세요.

파라미터 이름 간략 설명 타입 제약 필수 여부
autoScalingGroupName Auto Scaling Group의 이름 String 최소 길이 1바이트, 최대 길이 255바이트 Yes
launchConfigurationName Launch Configuration 이름 String 최소 길이 1바이트, 최대 길이 255바이트 No
desiredCapacity 기대 서비스 능력. 그 그룹 소속으로 운영될 서버 인스턴스들의 수 Integer minSize보다 크거나 같고 maxSize보다 작거나 같아야 함 No
minSize 최소 사이즈
Auto Scaling Group의 최소 사이즈
Integer 최소 0이고 maxSize 값보다 작거나 같아야 함 No
maxSize 최대 사이즈
Auto Scaling Group의 최대 사이즈
Integer 최소 0, 최대 100 No
defaultCooldown 디폴트 cooldown 시간 Integer 0 이상의 정수 No
healthCheckGracePeriod health check 보류 기간
단위는 초(sec)
서버 인스턴스가 서비스에 투입된 이후 health check를 보류할 시간
Integer 최소 0 Conditional
healthCheckTypeCode Health check 유형 코드
현재 서버 type과 로드밸런서 type이 있습니다
String SVR과 LOADB가 유효함 No
zoneNoList Zone 번호 리스트
이 그룹 소속 서버 인스턴스들이 존재할 zone 번호 리스트
String list No
  1. autoScalingGroupName

    • Auto Scaling Group의 이름
    • 그룹 식별자 역할을 합니다. 한 번 정해지면 그 뒤로는 불변입니다.
  2. launchConfigurationName

    • Launch Configuration 이름
    • 이 Auto Scaling Group 소속의 서버 인스턴스가 새로이 생성될 때 사용되는 서버 관련 정보를 담고 있습니다.
  3. desiredCapacity

    • 기대 서비스 능력
    • 그 그룹 소속으로 운영될 서버 인스턴스들의 수
  4. minSize

    • Auto Scaling Group의 최소 사이즈
  5. minSize

    • Auto Scaling Group의 최대 사이즈
  6. defaultCooldown

    • 디폴트 cooldown 시간
  7. healthCheckGracePeriod

    • health check 보류 기간
    • 서버 인스턴스가 서비스에 투입된 이후 health check를 보류할 시간
    • healthCheckTypeCode 값이 로드밸런서(LOADB)이면 필수
  8. healthCheckTypeCode

    • Health check 유형 코드
    • 현재 사용 가능한 유형(type) 코드로는 서버(SVR)과 로드밸런서(LOADB)가 있습니다.
  9. zoneNoList

    • Zone 번호 리스트
    • 이 그룹 소속 서버 인스턴스들이 존재할 zone 번호 리스트

응답 데이터 타입

아래에는 응답으로 받은 xml 문서의 최상위 태그(객체)의 데이터 타입 이름이 기재되어 있습니다. 그 데이터 타입에 대한 상세 명세는 [API 데이터 타입] 문서를 참고합니다.

- updateAutoScalingGroupResponse 타입

오류

다음 에러 코드는 이 액션(action)에서 특징적으로 발생하는 에러입니다. 이 특징적인 에러와 모든 action에서 공통적으로 발생하는 에러에 대한 상세한 설명은 3.2 장 ‘에러 정의’ 절을 참고합니다.

  • 50120 (InvalidParameterValue)

    desiredCapacity는 minSize보다 크거나 같고, maxSize보다 작거나 같아야 합니다. 그렇지 않으면 상기 에러가 발생합니다.

  • 50130 (LimitExceeded)

    maxSize가 지정되어 있다면 그 값은 100보다 작거나 같아야 합니다. 그렇지 않으면 상기 에러가 발생합니다

  • 50160 (ScalingActivityInProgress)

사용 예시

  • 요청

    http://api.ncloud.com/autoscaling/?action=updateAutoScalingGroup&autoScalingGroupName=asg-1&desiredCapacity=0&maxSize=0&minSize=0&AUTHPARAMS
    
  • 응답

    <updateAutoScalingGroupResponse>
    <requestId>5e40dcb6-56cc-46cd-ae08-98ec6e611cd9</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <autoScalingGroupList>
    <autoScalingGroup>
    <autoScalingGroupName>asg-1</autoScalingGroupName>
    <launchConfigurationName>lc-1</launchConfigurationName>
    <desiredCapacity>0</desiredCapacity>
    <minSize>0</minSize>
    <maxSize>0</maxSize>
    <loadBalancerInstanceSummeryList>
    <loadBalancerInstanceSummery>
    <loadBalancerName>slb-1</loadBalancerName>
    </loadBalancerInstanceSummery>
    <loadBalancerInstanceSummery>
    <loadBalancerName>slb-2</loadBalancerName>
    </loadBalancerInstanceSummery>
    </loadBalancerInstanceSummeryList>
    <healthCheckGracePeriod>600</healthCheckGracePeriod>
    <healthCheckType>
    <code>SVR</code>
    <codeName>Server</codeName>
    </healthCheckType>
    <createDate>2014-02-13T17:24:19+0900</createDate>
    <inAutoScalingGroupServerInstanceList>
    <InAutoScalingGroupServerInstance>
    <healthStatus>
    <code>HLTHY</code>
    <codeName>Healthy (normal)</codeName>
    </healthStatus>
    <lifecycleState>
    <code>INSVC</code>
    <codeName>In service</codeName>
    </lifecycleState>
    <launchConfiguration>
    <launchConfigurationName>lc-1</launchConfigurationName>
    <serverImageProductCode>SPSW0LINUX000009</serverImageProductCode>
    <serverProductCode>SPSVRSTAND000043</serverProductCode>
    <memberServerImageNo/>
    <loginKeyName>yh-nang-test</loginKeyName>
    <createDate>2014-02-13T13:45:57+0900</createDate>
    <userData/>
    </launchConfiguration>
    <serverInstanceNo>68084</serverInstanceNo>
    <serverInstanceName>svr-7f8879ae0826836</serverInstanceName>
    </InAutoScalingGroupServerInstance>
    </inAutoScalingGroupServerInstanceList>
    <suspendedProcessList/>
    <zoneList>
    <zone>
    <zoneNo>2</zoneNo>
    <zoneName>zone2</zoneName>
    <zoneDescription>nang zone</zoneDescription>
    </zone>
    <zone>
    <zoneNo>3</zoneNo>
    

Errors

액션(action)을 호출했을 때 에러가 발생하면, HTTP 4xx error 또는 5xx error와 함께 메시지 본체(body)로 다음과 같은 형식의 xml 문서를 받습니다. 에러의 종류는 수 형태의 returnCode 값으로 구분합니다. 이 에러에 대한 자세한 설명은 사람이 쉽게 읽기 쉬운 자연어 문자열 형태로 returnMessage 값으로 기재되어 있습니다.

<responseError>
<returnCode>50100</returnCode>
<returnMessage>
Resource already exists. The named Auto Scaling Group already exists.
</returnMessage>
</responseError>

다음 하위 절에는 각 에러에 대한 설명으로 기재되어 있습니다. 각 에러는 수 형태의 returnCode와 이 코드를 보조적으로 설명하는 우측 괄호 안의 스트링 형태의 에러 코드로 식별됩니다.

공통 에러 정의

모든 액션(action)의 결과로 받을 수 있는 공통의 에러를 기재하였습니다.

  • 50120 (InvalidParameterValue)

    • 설명 : 유효하지 않거나 허용 범위를 벗어난 값이 입력 파라미터로 제공합니다.
    • 에러 메시지 : An invalid or out-of-range value was supplied for the input parameter.
    • HTTP Status Code : 400

    그 밖에 Ncloud 서비스에서 제공하는 query API에서 공통으로 발생하는 에러는 다음과 같습니다.

    HTTP Response Code 리턴코드 리턴메시지
    400 900 – 999 파라미터 관련 오류
    400 1100 BAD REQUEST
    400 1400 – 1499 사용자에 의해 발생한 기타 오류
    401 800 – 899 인증관련 오류
    404 1101 NOT FOUND
    405 1102 METHOD NOT ALLOWED
    500 1000 – 1399 서버 내부 오류

특정 액션(action)에서 발생하는 에러 정의

특정 액션(action)의 결과로 받을 수 있는 에러를 설명합니다. 각 액션(action) 명세에는 발생할 수 있는 에러 코드가 기재되어 있습니다.

  • 50100 (AlreadyExists)
    • 설명 : 해당 자원이 이미 존재합니다.
    • 에러 메시지 : Resource already exists
    • HTTP Status Code : 400
  • 50110 (InvalidParameterCombination)
    • 설명 : 함께 사용되지 말아야 할 파라미터가 함께 사용되었습니다.
    • 에러 메시지 : Parameters that must not be used together were used together
    • HTTP Status Code : 400
  • 50130 (LimitExceeded)
    • 설명 : 사용자가 사용한 자원의 수가 고객님의 할당(quota) 한계에 도달했습니다.
    • 에러 메시지 : Quota for this customer has already been reached.
    • HTTP Status Code : 400
  • 50150 (ResourceInUse)
    • 설명 : 이 에러는 사용자가 현재 사용되고 있는 Auto Scaling Group과 Launch Configuration을 삭제하려 할 때 반환되는 에러입니다.
    • 에러 메시지 : This is returned when you cannot delete a Launch Configuration or Auto Scaling Group because it is being used.
    • HTTP Status Code : 400
  • 50160 (ScalingActivityInProgress)
    • 설명 : scaling action이 아직 진행 중일 때는 다른 action을 요청할 수 없습니다.
    • 에러 메시지 : You cannot request actions while there are scaling activities in progress for that group.
    • HTTP Status Code : 400

연관 정보 바로가기

아래 가이드에서 연관 정보를 확인할 수 있습니다.

""에 대한 건이 검색되었습니다.

    ""에 대한 검색 결과가 없습니다.

    처리중...