setTarget

Prev Next

Available in VPC

Set a target that will be applied to a target group.
Regardless of any previously applied target lists, only the newly specified target number list will be bound, and if no target number list is specified, all existing bound target lists are removed.

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 to which you want to bind the target
  • First Region of the getRegionList search result (default)
  • Check through getRegionList
targetGroupNo String Required Target group number
targetNoList.N List<String> Optional List of target numbers to bind
  • If you don't specify a list of target numbers, all existing bound target lists are removed
  • targetNo can be obtained through targetTypeCode
  • <E.g.> targetNoList.1=1234&targetNoList.2=2345
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/setTarget
?regionCode=KR
&targetGroupNo=*******
&targetNoList.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 TargetList 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.

<setTargetResponse>
    <requestId>6fbfbb6b-3ae7-4637-baba-521e1866108f</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <targetList>
        <target>
            <targetNo>********</targetNo>
            <targetName>YOUR_TARGET</targetName>
            <targetIp>***.***.*.*</targetIp>
            <healthCheckStatus>
                <code>UNUSED</code>
                <codeName>unused Target</codeName>
            </healthCheckStatus>
            <healthCheckResponse></healthCheckResponse>
        </target>
    </targetList>
</setTargetResponse>