Available in Classic
View the list of load balancer instances based on the conditions the user specifies.
Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| GET | /getLoadBalancerInstanceList |
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 |
|---|---|---|---|
loadBalancerInstanceNoList.N |
String | Optional | List of load balancer instance numbers
|
networkUsageTypeCode |
String | Optional | Network type of load balancer
|
regionNo |
String | Optional | Region number
|
zoneNo |
String | Optional | Zone number |
pageNo |
Integer | Optional | Page number in paged results
|
pageSize |
Integer | Optional | Number of results to display on a page
|
sortedBy |
String | Optional | Sort by
|
sortList.N.sortingOrder |
String | Optional | Sort order
|
Request example
The following is a sample request.
curl --location 'https://ncloud.apigw.ntruss.com/loadbalancer/v2/getLoadBalancerInstanceList
?loadBalancerInstanceNoList.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 LoadBalancerInstance 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.
<getLoadBalancerInstanceListResponse>
<requestId>352b6436-780d-4e6c-9ade-3828f213ba33</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<loadBalancerInstanceList>
<loadBalancerInstance>
<loadBalancerInstanceNo>********</loadBalancerInstanceNo>
<virtualIp>***.**.***.***,**.**.***.***</virtualIp>
<loadBalancerName>YOUR_LOAD_BALANCER</loadBalancerName>
<loadBalancerAlgorithmType>
<code>RR</code>
<codeName>Round Robin</codeName>
</loadBalancerAlgorithmType>
<loadBalancerDescription></loadBalancerDescription>
<createDate>2024-06-07T18:30:37+0900</createDate>
<domainName>***.com</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>PBLIP</code>
<codeName>Public</codeName>
</networkUsageType>
<isHttpKeepAlive>false</isHttpKeepAlive>
<connectionTimeout>60</connectionTimeout>
<certificateName></certificateName>
<region>
<regionNo>1</regionNo>
<regionCode>KR</regionCode>
<regionName>Korea</regionName>
</region>
<zoneList>
<zone>
<zoneNo>2</zoneNo>
<zoneName>KR-1</zoneName>
<zoneCode>KR-1</zoneCode>
<zoneDescription>Gasan zone</zoneDescription>
<regionNo>1</regionNo>
</zone>
<zone>
<zoneNo>3</zoneNo>
<zoneName>KR-2</zoneName>
<zoneCode>KR-2</zoneCode>
<zoneDescription>Pyeongchon zone</zoneDescription>
<regionNo>1</regionNo>
</zone>
</zoneList>
<loadBalancerRuleList>
<loadBalancerRule>
<protocolType>
<code>HTTP</code>
<codeName>http</codeName>
</protocolType>
<loadBalancerPort>80</loadBalancerPort>
<serverPort>80</serverPort>
<l7HealthCheckPath>/</l7HealthCheckPath>
<certificateName></certificateName>
<proxyProtocolUseYn>N</proxyProtocolUseYn>
<stickySessionUseYn>N</stickySessionUseYn>
<http2UseYn>N</http2UseYn>
</loadBalancerRule>
</loadBalancerRuleList>
<loadBalancedServerInstanceList>
<loadBalancedServerInstance>
<serverInstance>
<serverInstanceNo>********</serverInstanceNo>
<serverName>YOUR_SERVER</serverName>
<serverDescription></serverDescription>
<cpuCount>2</cpuCount>
<memorySize>4294967296</memorySize>
<baseBlockStorageSize>53687091200</baseBlockStorageSize>
<platformType>
<code>UBS64</code>
<codeName>Ubuntu Server 64 Bit</codeName>
</platformType>
<loginKeyName>YOUR_LOGIN_KEY</loginKeyName>
<isFeeChargingMonitoring>false</isFeeChargingMonitoring>
<publicIp></publicIp>
<privateIp>**.**.***.***</privateIp>
<serverImageName>ubuntu-18.04</serverImageName>
<serverInstanceStatus>
<code>RUN</code>
<codeName>Server run state</codeName>
</serverInstanceStatus>
<serverInstanceOperation>
<code>NULL</code>
<codeName>Server NULL OP</codeName>
</serverInstanceOperation>
<serverInstanceStatusName>running</serverInstanceStatusName>
<createDate>2024-06-07T18:28:41+0900</createDate>
<uptime>2024-06-07T18:35:09+0900</uptime>
<serverImageProductCode>SPSW0LINUX000130</serverImageProductCode>
<serverProductCode>SPSVRSSD00000003</serverProductCode>
<isProtectServerTermination>false</isProtectServerTermination>
<portForwardingPublicIp>***.***.***.***</portForwardingPublicIp>
<zone>
<zoneNo>2</zoneNo>
<zoneName>KR-1</zoneName>
<zoneCode>KR-1</zoneCode>
<zoneDescription>Gasan zone</zoneDescription>
<regionNo>1</regionNo>
</zone>
<region>
<regionNo>1</regionNo>
<regionCode>KR</regionCode>
<regionName>Korea</regionName>
</region>
<baseBlockStorageDiskType>
<code>NET</code>
<codeName>Network Storage</codeName>
</baseBlockStorageDiskType>
<baseBlockStorageDiskDetailType>
<code>SSD</code>
<codeName>SSD</codeName>
</baseBlockStorageDiskDetailType>
<serverInstanceType>
<code>STAND</code>
<codeName>Standard</codeName>
</serverInstanceType>
<userData></userData>
<initScriptNo></initScriptNo>
<accessControlGroupList>
<accessControlGroup>
<accessControlGroupConfigurationNo>******</accessControlGroupConfigurationNo>
<accessControlGroupName>ncloud-default-acg</accessControlGroupName>
<accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
<isDefault>true</isDefault>
<createDate>2021-06-22T18:09:57+0900</createDate>
</accessControlGroup>
</accessControlGroupList>
<instanceTagList/>
</serverInstance>
<serverHealthCheckStatusList>
<serverHealthCheckStatus>
<protocolType>
<code>HTTP</code>
<codeName>http</codeName>
</protocolType>
<loadBalancerPort>80</loadBalancerPort>
<serverPort>80</serverPort>
<l7HealthCheckPath>/</l7HealthCheckPath>
<proxyProtocolUseYn>N</proxyProtocolUseYn>
<serverStatus>false</serverStatus>
</serverHealthCheckStatus>
</serverHealthCheckStatusList>
</loadBalancedServerInstance>
</loadBalancedServerInstanceList>
</loadBalancerInstance>
</loadBalancerInstanceList>
</getLoadBalancerInstanceListResponse>