setTarget

Prev Next

Can be used in a VPC environment.

Summary

Set targets to apply to the target group.
A list of newly specified target numbers will be bound regardless of the list of previously applied targets.
If you do not specify the list of target numbers, all lists of targets previously bound will be removed.

Request

Request Parameters

Parameter name Requirement status Type Restrictions Description
regionCode No String Region code
You can decide the region of a target group where the target will be bound.
You can obtain the regionCode through the getRegionList action.
Default: Select the first region of the getRegionList search results
targetGroupNo Yes String Target group number
You can obtain the targetGroupNo through the getTargetGroupList action.
targetNoList.N No List<String> List of target numbers to bind
If you do not specify the list of target numbers, all lists of targets previously bound will be removed.
You can obtain the targetNo through the search action corresponding to the selected target group's targetTypeCode.
ex) targetNoList.1=1234&targetNoList.2=2345
responseFormatType No String Format type of the response results
Options : xml | json
Default : xml

Response

Response data type

  • TargetList type
TargetList extends CommonResponse
private Integer totalRows;
private List targetList = new ArrayList<>();
Target
private String targetNo;
private String targetName;
private String targetIp;
private CommonCode healthCheckStatus;
private String healthCheckResponse;

Example

Request example

ncloud vloadbalancer setTarget --regionCode KR --targetGroupNo ***095 --targetNoList ***4299

Response example

List of targets bound to the corresponding target group after executing the request

<setTargetResponse>
  <requestId>a4f8aa8d-aab1-4bb8-bad6-1d9006453945</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <targetList>
    <target>
      <targetNo>***4299</targetNo>
      <targetName>test-***</targetName>
      <targetIp>***.***.1.6</targetIp>
      <healthCheckStatus>
        <code>UNUSED</code>
        <codeName>unused Target</codeName>
      </healthCheckStatus>
      <healthCheckResponse></healthCheckResponse>
    </target>
  </targetList>
</setTargetResponse>