updateAutoScalingGroup

Prev Next

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

Auto Scaling Group의 상세 정보와 설정된 Launch Configuration을 수정합니다.

요청

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

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

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

요청 헤더

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

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
regionCode String Optional 리전 코드
  • getRegionList 참조
    • 조회 결과의 첫 번째 리전 (기본값)
autoScalingGroupNo String Required Auto Scaling Group 번호
launchConfigurationNo String Optional Launch Configuration 번호
serverNamePrefix String Optional 서버 이름 Prefix
  • 영문 소문자, 숫자, 특수 문자 '-'를 허용하며, 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)
  • 서버 초기 작업을 감안해 헬스 체크에 실패해도 서버를 비정상으로 판단하지 않는 시간
  • healthCheckTypeCode가 LOADB인 경우, 필수 입력
healthCheckTypeCode String Optional 헬스 체크 유형 코드
  • SVR (기본값) | LOADB
    • SVR: 서버
    • LOADB: 로드밸런서
  • LOADB인 경우, healthCheckGracePeriod 필수 입력
responseFormatType String Optional 응답 데이터의 형식
  • xml (기본값) | json
참고

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

  • 입력한 요청 쿼리 파라미터에 해당하는 정보만 수정되며, 입력하지 않은 요청 쿼리 파라미터에 대한 정보는 기존 값 유지
  • 필수 여부가 Optional인 요청 쿼리 파라미터 미입력 시 기존 값이 응답 결과에 표시 (200 OK)
  • minSize, maxSize, desiredCapacity 변경되어도 minSize ≤ desiredCapacity ≤ maxSize의 대소 관계 유효
  • updateAutoScalingGroup API 호출로 생성된 신규 Launch Configuration은 이후 생성되는 서버 인스턴스(VM)부터 반영
  • Scaling 진행 중인 Auto Scaling Group에 변경 요청 시 호출 실패

요청 예시

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vautoscaling/v2/updateAutoScalingGroup
?regionCode=KR
&autoScalingGroupNo=1***9
&maxSize=3
&desiredCapacity=0
&defaultCoolDown=600
&healthCheckGracePeriod=300
&healthCheckTypeCode=LOADB
&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}'

응답

응답 형식을 설명합니다.

응답 바디

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

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

응답 상태 코드

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

응답 예시

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

{
    "updateAutoScalingGroupResponse": {
        "totalRows": 1,
        "autoScalingGroupList": [
            {
                "vpcNo": "4**5",
                "subnetNo": "3***4",
                "serverNamePrefix": "",
                "autoScalingGroupNo": "1***9",
                "autoScalingGroupName": "asg",
                "launchConfigurationNo": "5891",
                "minSize": 0,
                "maxSize": 3,
                "desiredCapacity": 0,
                "defaultCoolDown": 600,
                "healthCheckGracePeriod": 300,
                "healthCheckType": {
                    "code": "LOADB",
                    "codeName": "로드밸런서"
                },
                "createDate": "2025-05-15T09:50:55+0900",
                "autoScalingGroupStatus": {
                    "code": "CREAT",
                    "codeName": "Created"
                },
                "targetGroupNoList": [],
                "inAutoScalingGroupServerInstanceList": [],
                "accessControlGroupNoList": [
                    "1***1"
                ],
                "suspendedProcessList": []
            }
        ],
        "requestId": "a8eb0d25-****-****-****-0b05a6829fb9",
        "returnCode": "0",
        "returnMessage": "success"
    }
}