createTargetGroup
    • PDF

    createTargetGroup

    • PDF

    기사 요약

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

    타깃 그룹을 생성합니다. 생성된 타깃 그룹은 로드 밸런서 또는 오토 스케일링 그룹에서 사용할 수 있습니다.

    요청

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

    메서드URI
    GET/createTargetGroup

    요청 헤더

    Load Balancer API에서 공통으로 사용하는 헤더에 대한 자세한 내용은 Load Balancer 공통 헤더를 참조해 주십시오.

    요청 쿼리 파라미터

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

    필드타입필수 여부설명
    regionCodeStringOptional생성하려는 타깃 그룹의 리전 코드
    • getRegionList 조회 결과의 첫 번째 리전(기본값)
    • getRegionList를 통해 확인
    vpcNoStringRequired생성하려는 타깃 그룹의 VPC 번호
    targetGroupNameStringOptional타깃 그룹의 이름
    • 네이버 클라우드 플랫폼이 자동으로 부여(기본값)
    • 3~30자로 영문자, 숫자, 특수문자 '-'를 허용하며 영문자로 시작해서 영문자 또는 숫자로 끝나야 함
    targetTypeCodeStringOptional타깃 그룹에 추가될 타깃 유형
    • VSVR
      • VSVR: Server (VPC)
    targetGroupProtocolTypeCodeStringRequired타깃 그룹의 프로토콜 유형
    • HTTP | HTTPS | TCP | UDP | PROXY_TCP
    • 사용하는 프로토콜에 따라서 적용할 수 있는 로드 밸런서의 유형이 제한됨
      • 애플리케이션 로드 밸런서: HTTP | HTTPS
      • 네트워크 로드 밸런서: TCP | UDP
      • 네트워크 프록시 로드 밸런서: PROXY_TCP
    • UDP 프로토콜은 싱가포르, 일본 리전에서만 이용 가능
    targetGroupPortIntegerOptional타깃 그룹에서 사용하는 포트
    • 1~65534 (기본값: 80)
    targetGroupDescriptionStringOptional타깃 그룹에 대한 설명(Byte)
    • 0~1,000
    healthCheckProtocolTypeCodeStringRequired타깃의 상태를 확인하기 위한 헬스 체크 수행 시 로드 밸런서가 사용하는 프로토콜
    • HTTP | HTTPS | TCP
    • 타깃 그룹의 프로토콜 유형에 따라서 선택할 수 있는 값이 제한됨
      • HTTP, HTTPS 프로토콜: HTTP, HTTPS
      • TCP, UDP, PROXY_TCP 프로토콜: TCP
    healthCheckPortIntegerOptional타깃의 상태를 확인하기 위한 헬스 체크 수행 시 로드 밸런서가 사용하는 포트
    • 1~65534 (기본값: 80)
    healthCheckUrlPathStringOptional헬스 체크 수행 시 사용할 URL 경로
    • / (기본값)
    • /로 시작하는 URL 경로
    • 타깃 그룹의 헬스 체크 프로토콜 유형이 HTTP 또는 HTTPS이면 설정 가능
    healthCheckHttpMethodTypeCodeStringConditional헬스 체크 수행 시 사용할 HTTP 메서드 유형
    • HEAD | GET
    • 타깃 그룹의 헬스 체크 프로토콜 유형이 HTTP 또는 HTTPS이면 필수 입력
    healthCheckCycleIntegerOptional헬스 체크 주기(초)
    • 5~300 (기본값: 30)
    healthCheckUpThresholdIntegerOptional타깃 상태를 정상이라고 판단하기 위해 필요한 연속적인 헬스 체크 성공 횟수
    • 2~10 (기본값: 2)
    healthCheckDownThresholdIntegerOptional타깃 상태를 비정상이라고 판단하기 위해 필요한 연속적인 헬스 체크 실패 횟수
    • 2~10 (기본값: 2)
    targetNoList.NList<String>Optional타깃 그룹에 바인딩할 타깃 목록
    • targetNotargetTypeCode를 통해 확인
    • <예시> targetNoList.1=1234&targetNoList.2=2345
    responseFormatTypeStringOptional응답 결과의 형식
    • xml (기본값) | json

    요청 예시

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

    curl --location 'https://ncloud.apigw.ntruss.com/vloadbalancer/v2/createTargetGroup
    ?regionCode=KR
    &vpcNo=*****
    &targetGroupName=YOUR_TARGET_GROUP
    &targetTypeCode=VSVR
    &targetGroupProtocolTypeCode=HTTP
    &targetGroupPort=80
    &healthCheckProtocolTypeCode=HTTP
    &healthCheckPort=80
    &healthCheckUrlPath=/
    &healthCheckHttpMethodTypeCode=GET
    &healthCheckCycle=30
    &healthCheckUpThreshold=2
    &healthCheckDownThreshold=2'
    --header 'x-ncp-apigw-timestamp: {Timestamp}'
    --header 'x-ncp-iam-access-key: {Access Key}'
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
    

    응답

    응답 형식을 설명합니다.

    응답 바디

    응답 바디는 TargetGroupList를 참조해 주십시오.

    응답 상태 코드

    네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 Ncloud API 응답 상태 코드를 참조해 주십시오.

    응답 예시

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

    <createTargetGroupResponse>
        <requestId>f5356756-9e75-4e69-94a8-8c88e270b5d2</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <targetGroupList>
            <targetGroup>
                <targetGroupNo>*******</targetGroupNo>
                <targetGroupName>YOUR_TARGET_GROUP</targetGroupName>
                <targetType>
                    <code>VSVR</code>
                    <codeName>Server (VPC)</codeName>
                </targetType>
                <vpcNo>*****</vpcNo>
                <targetGroupProtocolType>
                    <code>HTTP</code>
                    <codeName>HTTP protocol</codeName>
                </targetGroupProtocolType>
                <targetGroupPort>80</targetGroupPort>
                <targetGroupDescription></targetGroupDescription>
                <useStickySession>false</useStickySession>
                <useProxyProtocol>false</useProxyProtocol>
                <algorithmType>
                    <code>RR</code>
                    <codeName>Round Robin</codeName>
                </algorithmType>
                <createDate>2024-06-04T10:17:10+0900</createDate>
                <regionCode>KR</regionCode>
                <loadBalancerInstanceNo></loadBalancerInstanceNo>
                <healthCheckProtocolType>
                    <code>HTTP</code>
                    <codeName>HTTP protocol</codeName>
                </healthCheckProtocolType>
                <healthCheckPort>80</healthCheckPort>
                <healthCheckUrlPath>/</healthCheckUrlPath>
                <healthCheckHttpMethodType>
                    <code>GET</code>
                    <codeName>HTTP GET Method</codeName>
                </healthCheckHttpMethodType>
                <healthCheckCycle>30</healthCheckCycle>
                <healthCheckUpThreshold>2</healthCheckUpThreshold>
                <healthCheckDownThreshold>2</healthCheckDownThreshold>
                <targetNoList/>
            </targetGroup>
        </targetGroupList>
    </createTargetGroupResponse>
    

    이 문서가 도움이 되었습니까?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.