getLoadBalancerInstanceList
- Print
- PDF
getLoadBalancerInstanceList
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Overview
Gets a list of load balancer instances.
Request
Request header
Header | Description |
---|---|
x-ncp-apigw-timestamp | It is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. If the time difference with the API Gateway server is more than 5 minutes, the request is considered invalid. |
x-ncp-apigw-api-key | API key issued by API Gateway (not used in the API v2.) |
x-ncp-iam-access-key | API key issued by NAVER Cloud Platform or access key issued by IAM |
x-ncp-apigw-signature-v2 | Signature used to encrypt the body with the “secret key” that maps with the “access key.” The HMAC encryption algorithm is HMAC SHA256. |
Request parameters
Parameter | Required | Type | Limitations | Description |
---|---|---|---|---|
loadBalancerInstanceNoList.N | N | String | Duplicates not allowed. | List of load balancer instance numbers You can filter results by load balancer instance number. Example)loadBalancerInstanceNoList.1=123&loadBalancerInstanceNoList.2=345 |
networkUsageTypeCode | N | String | Min: 1 Max: 5 | You can filter results by networkUsageTypeCode. (Public IP load balancer/Private IP load balancer)PBLIP (Public) , PRVT (Private) |
regionNo | N | String | This parameter limits results to the specified region. Get available values by using the getRegionList action. Default: 1 (KR) | |
zoneNo | N | String | This parameter limits results to the specified zone. Get available values by using the getZoneList action. If both regionNo and zoneNo are specified, the API gets results based on the zone number. | |
pageNo | N | Integer | Min: 0 Max: 2147483647 | Page number of paginated results You can paginate results with pageNo and pageSize . |
pageSize | N | Integer | Min: 0 Max: 2147483647 | Page size to show when paginating results. You can paginate results with pageNo and pageSize . |
sortedBy | N | String | Sort byloadBalancerName (Load balancer name) loadBalancerInstanceNo (Load balancer instance number) Default: loadBalancerInstanceNo (Load balancer instance number) Case insensitive | |
sortingOrder | N | String | Sorting order ascending descending Default: ascending Case insensitive |
Response
Response body
Examples
Request example
GET {LOADBALANCER_API_URL}/loadbalancer/v2/getLoadBalancerInstanceList?loadBalancerInstanceNoList.1=757593
Response example
Errors that may occur while using this action are listed below. For information on common errors, refer to NAVER Cloud Platform.
<getLoadBalancerInstanceListResponse>
<requestId>9a1fd360-8f49-4842-b0fa-2f06d28234b4</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<loadBalancerInstanceList>
<loadBalancerInstance>
<loadBalancerInstanceNo>1083108</loadBalancerInstanceNo>
<virtualIp>49.236.150.32,49.236.151.188</virtualIp>
<loadBalancerName>penguin</loadBalancerName>
<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>
<region>
<regionNo>1</regionNo>
<regionCode>KR</regionCode>
<regionName>Korea</regionName>
</region>
<loadBalancerAlgorithmType>
<code>RR</code>
<codeName>Round Robin</codeName>
</loadBalancerAlgorithmType>
<loadBalancerDescription></loadBalancerDescription>
<createDate>2018-11-26T11:04:31+0900</createDate>
<domainName>slb-1083108.ncloudslb.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>
<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/>
</loadBalancerInstance>
</loadBalancerInstanceList>
</getLoadBalancerInstanceListResponse>
Was this article helpful?