getLoadBalancerInstanceList

Article summary

Did you find this summary helpful?

Thank you for your feedback

Overview

Searching a list of load balancer instance

Description

Search a list of load balancer instance.

Request Parameters

Parameter Name	Requiredness	Type	Limitation	Description
loadBalancerInstanceNoList	No	String	Repeat not allowed	List of Load balancer instance No. to search
networkUsageTypeCode	No	String	Min : 1, Max : 5	Network usage type code PBLIP(Public), PRVT(Private)
regionNo	No	String		You can reach a state in which input is possible by calling getRegionList.
pageNo	No	Integer	Min : 0, Max : 2147483647	Page No. for each page size when there are multiple cases
pageSize	No	Integer	Min : 0, Max : 2147483647	Page size for one search page
sortedBy	No	String		You can set sorting columns for list results. Load balancer name (loadBalancerName) \| Load balancer instance No. (loadBalancerInstanceNo) [Do not distinguish between uppercase and lowercase.] Default: Load balancer instance No. (loadBalancerInstanceNo)
sortingOrder	No	String		You can set ordering for list results in ascending or descending order. ascending \| descending [Do not distinguish between uppercase and lowercase.] Default: ascending

Response Data Type

LoadBalancerInstanceList type

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

LoadBalancerInstance
private String loadBalancerInstanceNo;
private String virtualIp;
private String loadBalancerName;
private CommonCode loadBalancerAlgorithmType;
private String loadBalancerDescription;
private Date createDate;
private String domainName;
private String loadBalancerInstanceStatusName;
private CommonCode loadBalancerInstanceStatus;
private CommonCode loadBalancerInstanceOperation;
private CommonCode networkUsageType;
private boolean isHttpKeepAlive;
private Integer connectionTimeout;
private String certificateName;
private List loadBalancerRuleList;
private List loadBalancedServerInstanceList;

Examples

Requset

ncloud loadbalancer getLoadBalancerInstanceList --networkUsageTypeCode PRVT

Response

{
  "getLoadBalancerInstanceListResponse": {
    "requestId": "d3a5be52-2003-4243-a037-3a1734210140",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 1,
    "loadBalancerInstanceList": [
    {
        "loadBalancerInstanceNo": 428577,
        "virtualIp": "10.39.10.76",
        "loadBalancerName": "cdb",
        "loadBalancerAlgorithmType": {
          "code": "RR",
          "codeName": "Round Robin"
        },
        "loadBalancerDescription": "",
        "createDate": "0133-10-23T21:01:41+0900",
        "domainName": "",
        "loadBalancerInstanceStatusName": "used",
        "loadBalancerInstanceStatus": {
          "code": "USED",
          "codeName": "NET USED state"
        },
        "loadBalancerInstanceOperation": {
          "code": "NULL",
          "codeName": "NET NULL OP"
        },
        "networkUsageType": {
          "code": "PRVT",
          "codeName": "Private "
        },
        "isHttpKeepAlive": false,
        "connectionTimeout": 60,
        "certificateName": "",
        "loadBalancerRuleList": [
          {
            "protocolType": {
              "code": "HTTP",
              "codeName": "http"
            },
            "loadBalancerPort": 88,
            "serverPort": 88,
            "l7HealthCheckPath": "/l7check.html",
            "certificateName": "",
            "proxyProtocolUseYn": "N",
            "stickySessionUseYn": "N",
            "http2UseYn": "N"
          }
        ],
        "loadBalancedServerInstanceList": [
          ""
        ]
      }
    ]
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<getLoadBalancerInstanceListResponse>
  <requestId>d3a5be52-2003-4243-a037-3a1734210140</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <loadBalancerInstanceList>
    <loadBalancerInstanceNo>428577</loadBalancerInstanceNo>
    <virtualIp>10.39.10.76</virtualIp>
    <loadBalancerName>cdb</loadBalancerName>
    <loadBalancerAlgorithmType>
      <code>RR</code>
      <codeName>Round Robin</codeName>
    </loadBalancerAlgorithmType>
    <loadBalancerDescription></loadBalancerDescription>
    <createDate>0133-10-23T21:01:41+0900</createDate>
    <domainName></domainName>
    <loadBalancerInstanceStatusName>used</loadBalancerInstanceStatusName>
    <loadBalancerInstanceStatus>
      <code>USED</code>
      <codeName>NET USED state</codeName>
    </loadBalancerInstanceStatus>
    <loadBalancerInstanceOperation>
      <code>NULL</code>
      <codeName>NET NULL OP</codeName>
    </loadBalancerInstanceOperation>
    <networkUsageType>
      <code>PRVT</code>
      <codeName>Private </codeName>
    </networkUsageType>
    <isHttpKeepAlive>false</isHttpKeepAlive>
    <connectionTimeout>60</connectionTimeout>
    <certificateName></certificateName>
    <loadBalancerRuleList>
      <protocolType>
        <code>HTTP</code>
        <codeName>http</codeName>
      </protocolType>
      <loadBalancerPort>88</loadBalancerPort>
      <serverPort>88</serverPort>
      <l7HealthCheckPath>/l7check.html</l7HealthCheckPath>
      <certificateName></certificateName>
      <proxyProtocolUseYn>N</proxyProtocolUseYn>
      <stickySessionUseYn>N</stickySessionUseYn>
      <http2UseYn>N</http2UseYn>
    </loadBalancerRuleList>
    <loadBalancedServerInstanceList></loadBalancedServerInstanceList>
  </loadBalancerInstanceList>
</getLoadBalancerInstanceListResponse>

Was this article helpful?

What's Next

createLoadBalancerInstance

Table of contents

Overview
Description
Request Parameters
Response Data Type
Examples