getTargetGroupList

Prev Next

Available in VPC

View the list of target groups.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method URI
GET /getTargetGroupList

Request headers

For headers common to all Load Balancer APIs, see Load Balancer common headers.

Request query parameters

The following describes the parameters.

Field Type Required Description
regionCode String Optional Region code for the target group whose list you want to view
  • First Region of the getRegionList search result (default)
  • Check through getRegionList
vpcNo String Optional VPC number of the target group whose list you want to view
targetTypeCode String Optional Target type
  • VSVR
    • VSVR: Server (VPC)
targetGroupNoList.N List<String> Optional Number list of the target group
  • targetGroupNo can be obtained through getTargetGroupList
  • <E.g.> targetGroupNoList.1=1234&targetGroupNoList.2=2345
pageNo Integer Optional Page number in paged results
pageSize Integer Conditional Number of results to display on a page
  • It is required when entering pageNo
sortList.N.sortedBy String Optional Sort by
  • targetGroupNo | targetGroupName
    • targetGroupNo: target group number
    • targetGroupName: target group name
  • <E.g.> sortList.1.sortedBy=targetGroupNo
sortList.N.sortingOrder String Optional Sort order
  • ASC (default) | DESC
    • ASC: ascending
    • DESC: descending
  • <E.g.> sortList.1.sortingOrder=DESC
responseFormatType String Optional Response result format
  • xml (default) | json

Request example

The following is a sample request.

curl --location 'https://ncloud.apigw.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}'

Response

The following describes the response format.

Response body

See TargetGroupList for the response body.

Response status codes

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

The following is a sample response.

<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>