getTargetGroupList

Article summary

Did you find this summary helpful?

Thank you for your feedback

Can be used in a VPC environment.

Summary

Search list of target groups.

Request

Request Parameters

Parameter name	Requirement status	Type	Description
regionCode	No	String	Region code You can decide the region where the list of target groups will be searched. You can obtain the regionCode through the getRegionList action. Default: Select the first region of the getRegionList search results
vpcNo	No	String	VPC number You can search by filtering with an VPC number. You can obtain the vpcNo through the getVpcList action.
targetTypeCode	No	String	Target type code You can search by filtering with a target type code. Options : VSVR (Server (VPC))
targetGroupNoList.N	No	List<String>	List of target group numbers You can search by filtering with a target group number. You can obtain the targetGroupNo through the getTargetGroupList action. ex) targetGroupNoList.1=1234&targetGroupNoList.2=2345
pageNo	No	Integer	Page number of the paged results The results can be paged using pageNo and pageSize.
pageSize	Conditional	Integer	Each page size to be displayed when paging The results can be paged using pageNo and pageSize. You must enter it when entering pageNo.
sortList.N.sortedBy	No	String	Sorted by You can sort the result by a member target group number and target group name. Options : targetGroupNo \| targetGroupName ex) sortList.1.sortedBy=targetGroupNo
sortList.N.sortingOrder	No	String	Sorting order When using sortedBy, sort in ascending/descending order. Options: ASC (ascending order) \| DESC (descending order) Default : ASC ex) sortList.1.sortingOrder=DESC
responseFormatType	No	String	Format type of the response results Options : xml \| json Default : xml

Response

Response data type

TargetGroupList type

TargetGroupList extends CommonResponse
private Integer totalRows;
private List targetGroupList = new ArrayList<>();

TargetGroup
private String targetGroupNo;
private String targetGroupName;
private CommonCode targetType;
private String vpcNo;
private CommonCode targetGroupProtocolType;
private Integer targetGroupPort;
private String targetGroupDescription;
private Boolean useStickySession;
private Boolean useProxyProtocol;
private CommonCode algorithmType;
private Date createDate;
private String regionCode;
private String loadBalancerInstanceNo;
private CommonCode healthCheckProtocolType;
private Integer healthCheckPort;
private String healthCheckUrlPath;
private CommonCode healthCheckHttpMethodType;
private Integer healthCheckCycle;
private Integer healthCheckUpThreshold;
private Integer healthCheckDownThreshold;
private TargetNoList targetNoList;

TargetNoList
private List targetNoList = new ArrayList<>();

Example

Request example

ncloud vloadbalancer getTargetGroupList --regionCode KR --vpcNo ***04 --targetTypeCode VSVR --targetGroupNoList ***095

Response example

<getTargetGroupListResponse>
  <requestId>b644e5ed-6ca8-48d5-9b7f-2a3549ef3c96</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <targetGroupList>
    <targetGroup>
      <targetGroupNo>***095</targetGroupNo>
      <targetGroupName>test-***</targetGroupName>
      <targetType>
        <code>VSVR</code>
        <codeName>Server (VPC)</codeName>
      </targetType>
      <vpcNo>***04</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>2020-12-17T21:06:45+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>get</codeName>
      </healthCheckHttpMethodType>
      <healthCheckCycle>30</healthCheckCycle>
      <healthCheckUpThreshold>2</healthCheckUpThreshold>
      <healthCheckDownThreshold>2</healthCheckDownThreshold>
      <targetNoList/>
    </targetGroup>
  </targetGroupList>
</getTargetGroupListResponse>

Was this article helpful?

What's Next

getTargetGroupDetail

Table of contents

Summary
Request
Response
Example