getTargetGroupList

Prev Next

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

타깃 그룹 목록을 조회합니다.

요청

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

메서드 URI
GET /getTargetGroupList

요청 헤더

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

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
regionCode String Optional 목록을 조회하려는 타깃 그룹의 리전 코드
  • getRegionList 조회 결과의 첫 번째 리전(기본값)
  • getRegionList를 통해 확인
vpcNo String Optional 목록을 조회하려는 타깃 그룹의 VPC 번호
targetTypeCode String Optional 타깃 유형
  • VSVR
    • VSVR: Server (VPC)
targetGroupNoList.N List<String> Optional 타깃 그룹의 번호 목록
  • targetGroupNo는 getTargetGroupList를 통해 확인
  • <예시> targetGroupNoList.1=1234&targetGroupNoList.2=2345
pageNo Integer Optional 페이징 처리된 결과의 페이지 번호
pageSize Integer Conditional 한 페이지에 보여줄 결과 개수
  • pageNo 입력 시 필수
sortList.N.sortedBy String Optional 정렬 기준
  • targetGroupNo | targetGroupName
    • targetGroupNo: 타깃 그룹의 번호
    • targetGroupName: 타깃 그룹의 이름
  • <예시> sortList.1.sortedBy=targetGroupNo
sortList.N.sortingOrder String Optional 정렬 순서
  • ASC (기본값) | DESC
    • ASC: 오름차순
    • DESC: 내림차순
  • <예시> sortList.1.sortingOrder=DESC
responseFormatType String Optional 응답 결과의 형식
  • xml (기본값) | json

요청 예시

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

curl --location 'https://ncloud.apigw.gov-ntruss.com/vloadbalancer/v2/getTargetGroupList
?regionCode=KR
&vpcNo=*****
&targetTypeCode=VSVR
&targetGroupNoList.1=*******'
--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 응답 상태 코드를 참조해 주십시오.

응답 예시

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

<getTargetGroupListResponse>
    <requestId>875c17ee-75cd-4bec-a0bd-1bac824d779f</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-03T17:09:27+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>
</getTargetGroupListResponse>