VPC 환경에서 이용 가능합니다.
타깃 그룹 번호를 이용하여 타깃 그룹의 상세 정보를 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| GET | /vloadbalancer/v2/getTargetGroupDetail |
요청 헤더
Load Balancer API에서 공통으로 사용하는 헤더에 대한 정보는 Load Balancer 요청 헤더를 참조해 주십시오.
요청 쿼리 파라미터
요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
regionCode |
String | Optional | 상세 정보를 조회하려는 타깃 그룹의 리전 코드
|
targetGroupNo |
String | Required | 타깃 그룹의 번호 |
responseFormatType |
String | Optional | 응답 결과의 형식
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location 'https://ncloud.apigw.gov-ntruss.com/vloadbalancer/v2/getTargetGroupDetail?regionCode=KR&targetGroupNo=*******' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디는 TargetGroupList를 참조해 주십시오.
응답 상태 코드
Load Balancer API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Load Balancer 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
<getTargetGroupDetailResponse>
<requestId>a964a3d2-cca3-4a7e-bc2c-2183990fb366</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-03T14:25:42+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>
</getTargetGroupDetailResponse>