getLoadBalancerInstanceList

Article summary

Did you find this summary helpful?

Thank you for your feedback

Can be used in a VPC environment.

Summary

Search list of load balancer instances.

Request

Request Parameters

Parameter name	Requirement status	Type	Description
regionCode	No	String	Region code - You can decide the region where the list of load balancer instances 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.
loadBalancerTypeCode	No	String	Load balancer type code - You can search by filtering with a load balancer type. - Options : APPLICATION \| NETWORK \| NETWORK_PROXY
loadBalancerNetworkTypeCode	No	String	Load balancer network type code - You can search by filtering with a load balancer network type. - Options : PUBLIC \| PRIVATE
loadBalancerInstanceNoList.N	No	List<String>	List of load balancer instance numbers - You can search by filtering with a load balancer instance number. - You can obtain the loadBalancerInstanceNo through the getLoadBalancerInstanceList action. - ex) loadBalancerInstanceNoList.1=1234&loadBalancerInstanceNoList.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 results by the load balancer name. - Options : loadBalancerName - ex) sortList.1.sortedBy=loadBalancerName
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

LoadBalancerInstanceList type

LoadBalancerInstanceList extends CommonResponse
private Integer totalRows;
private List loadBalancerInstanceList = new ArrayList<>();

LoadBalancerInstance
private String loadBalancerInstanceNo;
private CommonCode loadBalancerInstanceStatus;
private CommonCode loadBalancerInstanceOperation;
private String loadBalancerInstanceStatusName;
private String loadBalancerDescription;
private Date createDate;
private String loadBalancerName;
private String loadBalancerDomain;
private LoadBalancerIpList loadBalancerIpList;
private CommonCode loadBalancerType;
private CommonCode loadBalancerNetworkType;
private CommonCode throughputType;
private Integer idleTimeout;
private String vpcNo;
private String regionCode;
private SubnetNoList subnetNoList;
private List<LoadBalancerSubnet> loadBalancerSubnetList;
private LoadBalancerListenerNoList loadBalancerListenerNoList;

LoadBalancerIpList
private List loadBalancerIpList = new ArrayList<>();

SubnetNoList
private List subnetNoList = new ArrayList<>();

LoadBalancerSubnet
private String zoneCode;
private String subnetNo;
private String publicIpInstanceNo;

LoadBalancerListenerNoList
private List loadBalancerListenerNoList = new ArrayList<>();

Example

Request example

ncloud vloadbalancer getLoadBalancerInstanceList --regionCode KR --vpcNo ***04 --loadBalancerTypeCode APPLICATION --loadBalancerNetworkTypeCode PRIVATE --loadBalancerInstanceNoList ***887

Response example

<getLoadBalancerInstanceListResponse>
  <requestId>959a2fe5-fd1b-459a-9af3-df0e51b68e1d</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <loadBalancerInstanceList>
    <loadBalancerInstance>
      <loadBalancerInstanceNo>***887</loadBalancerInstanceNo>
      <loadBalancerInstanceStatus>
        <code>USED</code>
        <codeName>LB USED state</codeName>
      </loadBalancerInstanceStatus>
      <loadBalancerInstanceOperation>
        <code>NULL</code>
        <codeName>LB NULL OP</codeName>
      </loadBalancerInstanceOperation>
      <loadBalancerInstanceStatusName>Running</loadBalancerInstanceStatusName>
      <loadBalancerDescription></loadBalancerDescription>
      <createDate>2020-12-20T19:21:02+0900</createDate>
      <loadBalancerName>test-***</loadBalancerName>
      <loadBalancerDomain>test-***-***887-***.com</loadBalancerDomain>
      <loadBalancerIpList>
        <loadBalancerIp>***.***.5.6</loadBalancerIp>
      </loadBalancerIpList>
      <loadBalancerType>
        <code>APPLICATION</code>
        <codeName>Application Load Balancer</codeName>
      </loadBalancerType>
      <loadBalancerNetworkType>
        <code>PRIVATE</code>
        <codeName>Private</codeName>
      </loadBalancerNetworkType>
      <throughputType>
        <code>SMALL</code>
        <codeName>Small</codeName>
      </throughputType>
      <idleTimeout>60</idleTimeout>
      <vpcNo>***04</vpcNo>
      <regionCode>KR</regionCode>
      <subnetNoList>
        <subnetNo>***43</subnetNo>
      </subnetNoList>
      <loadBalancerSubnetList>
        <loadBalancerSubnet>
          <zoneCode>KR-1</zoneCode>
          <subnetNo>***43</subnetNo>
          <publicIpInstanceNo/>
        </loadBalancerSubnet>
      </loadBalancerSubnetList>
      <loadBalancerListenerNoList>
        <loadBalancerListenerNo>***961</loadBalancerListenerNo>
      </loadBalancerListenerNoList>
    </loadBalancerInstance>
  </loadBalancerInstanceList>
</getLoadBalancerInstanceListResponse>

Was this article helpful?

What's Next

getLoadBalancerInstanceDetail

Table of contents

Summary
Request
Response
Example