createAutoScalingGroup

Prev Next

VPC 환경에서 이용 가능합니다.

Auto Scaling Group을 생성합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET | POST /vautoscaling/v2/createAutoScalingGroup
참고

가이드는 GET 방식 기준으로 안내합니다. POST 방식의 호출 테스트는 네이버 클라우드 플랫폼 콘솔의 API Gateway 서비스에서 Swagger를 통해서 가능합니다.

요청 헤더

Auto Scaling API에서 공통으로 사용하는 헤더에 대한 정보는 Auto Scaling 요청 헤더를 참조해 주십시오.

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
regionCode String Optional 리전 코드
  • getRegionList 참조
    • 조회 결과의 첫 번째 리전 (기본값)
launchConfigurationNo String Required Launch Configuration 번호
autoScalingGroupName String Optional Auto Scaling Group 이름
  • 영문 소문자, 숫자, 특수 문자 '-'를 허용하며, 1~255자 이내로 입력
  • 문자열의 시작은 영문 소문자, 마지막은 영문 소문자 또는 숫자로 구성
  • 미입력 시 자동 생성 (기본값)
vpcNo String Required VPC 번호
subnetNo String Required Subnet 번호
accessControlGroupNoList.N Array Required ACG 번호 목록
  • getAccessControlGroupList 참조
  • Scale-out 시 생성되는 서버에 적용
  • 1~3개 입력 가능
  • <예시> accessControlGroupNoList.1=1234&accessControlGroupNoList.2=2345
serverNamePrefix String Optional 서버 이름 Prefix
  • s (기본값)
  • 영문 소문자, 숫자, 특수 문자 '-'를 허용하며, 3~7자 이내로 입력
  • 문자열의 시작은 영문 소문자, 마지막은 영문 소문자 또는 숫자로 구성
  • 서버 이름 규칙: {Prefix}-{영문|숫자}이며, Prefix를 제외한 나머지는 자동 생성
minSize Integer Required 최소 용량: Auto Scaling Group의 최소 서버 수
  • 0~30
  • maxSize 이하로 설정
  • 서버를 보유하지 않으려면 0 입력
maxSize Integer Required 최대 용량: Auto Scaling Group의 최대 서버 수
  • 0~30
  • minSize 이상으로 설정
desiredCapacity Integer Optional 기대 용량: Auto Scaling Group의 기대 서버 수
  • minSize 이상, maxSize 이하로 설정 (기본값: minSize와 동일)
  • 입력 값에 따라 서버 수 자동 조정
defaultCoolDown Integer Optional 쿨다운 기본값(초)
  • 0~2147483647 (기본값: 300)
  • Scaling 후 서버 준비를 위한 모니터링 대기 시간
healthCheckGracePeriod Integer Conditional 헬스 체크 보류 기간(초)
  • 0~2147483647 (기본값: 300)
  • 서버 초기 작업을 감안해 헬스 체크에 실패해도 서버를 비정상으로 판단하지 않는 시간
  • healthCheckTypeCodeLOADB인 경우, 필수 입력
healthCheckTypeCode String Optional 헬스 체크 유형 코드
  • SVR (기본값) | LOADB
    • SVR: 서버
    • LOADB: 로드밸런서
  • LOADB인 경우, healthCheckGracePeriod 필수 입력
targetGroupNoList.N Array Optional Target Group 번호 목록
  • getTargetGroupList 참조
  • 각 그룹의 헬스 체크 방식과 기준에 따라 서버 상태 판단
  • healthCheckTypeCodeLOADB인 경우에만 유효
  • <예시> targetGroupNoList.1=1234&targetGroupNoList.2=2345
responseFormatType String Optional 응답 데이터의 형식
  • xml (기본값) | json
참고

요청 쿼리 파라미터 입력 시 다음 내용을 참고해 주십시오.

  • defaultCoolDown: 새로운 서버가 생성되어도 초기화 스크립트 실행이나 업데이트 설치 등의 이유로 실제 서비스를 수행할 수 있을 정도로 준비되기까지 일정 시간이 소요됩니다. 이를 고려하여 실제 Scaling이 수행 중이거나 수행 완료된 이후에 모니터링 이벤트 알람이 발생하더라도 반응하지 않고 무시하도록 설정한 기간을 쿨다운(Cooldown) 시간이라고 정의합니다.
  • healthCheckGracePeriod: 서버가 생성된 후 운영 중 상태로 변경되었음에도 업데이트 설치 등 작업으로 인해 헬스 체크에 정상 응답하지 못할 수 있습니다. 이를 고려하여 헬스 체크에 실패하더라도 서버에 이상이 없다고 판단하는 헬스체크 보류 기간을 설정할 수 있습니다.

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vautoscaling/v2/createAutoScalingGroup
?regionCode=KR
&launchConfigurationNo=5891
&vpcNo=4**5
&subnetNo=3***4
&accessControlGroupNoList.1=1***1
&minSize=0
&maxSize=1
&desiredCapacity=0
&healthCheckTypeCode=SVR
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
createAutoScalingGroupResponse Object - 응답 결과
createAutoScalingGroupResponse.requestId String - 요청에 대한 아이디
  • UUID 형식
createAutoScalingGroupResponse.returnCode String - 응답 코드
createAutoScalingGroupResponse.returnMessage String - 응답 메시지

응답 상태 코드

Auto Scaling API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Auto Scaling 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "createAutoScalingGroupResponse": {
        "totalRows": 1,
        "autoScalingGroupList": [
            {
                "vpcNo": "4**5",
                "subnetNo": "3***4",
                "serverNamePrefix": "",
                "autoScalingGroupNo": "1***1",
                "autoScalingGroupName": "as19762e46344",
                "launchConfigurationNo": "5891",
                "minSize": 0,
                "maxSize": 1,
                "desiredCapacity": 0,
                "defaultCoolDown": 300,
                "healthCheckGracePeriod": 300,
                "healthCheckType": {
                    "code": "SVR",
                    "codeName": "서버"
                },
                "createDate": "2025-06-12T15:47:04+0900",
                "autoScalingGroupStatus": {
                    "code": "CREAT",
                    "codeName": "Created"
                },
                "targetGroupNoList": [],
                "inAutoScalingGroupServerInstanceList": [],
                "accessControlGroupNoList": [
                    "1***1"
                ],
                "suspendedProcessList": []
            }
        ],
        "requestId": "cb3b0c69-****-****-****-179d71217eea",
        "returnCode": "0",
        "returnMessage": "success"
    }
}