Available in VPC
View details using the number of a load balancer instance.
Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| GET | /vloadbalancer/v2/getLoadBalancerInstanceDetail |
Request headers
For information about the headers common to all Load Balancer APIs, see Load Balancer request headers.
Request query parameters
You can use the following query parameters with your request:
| Field | Type | Required | Description |
|---|---|---|---|
regionCode |
String | Optional | Region code of the load balancer instance whose details you want to view
|
loadBalancerInstanceNo |
String | Required | Number of the load balancer instance |
responseFormatType |
String | Optional | Response result format
|
Request example
The following is a sample request.
curl --location 'https://ncloud.apigw.ntruss.com/vloadbalancer/v2/getLoadBalancerInstanceDetail?regionCode=KR&loadBalancerInstanceNo=********' \
--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 LoadBalancerInstanceList for the response body.
Response status codes
For information about the HTTP status codes common to all Load Balancer APIs, see Load Balancer response status codes.
Response example
The following is a sample response.
<getLoadBalancerInstanceListResponse>
<requestId>c9187284-6156-4112-ba35-1cce367b1239</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<loadBalancerInstanceList>
<loadBalancerInstance>
<loadBalancerInstanceNo>********</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>2024-06-03T17:09:52+0900</createDate>
<loadBalancerName>YOUR_LOAD_BALANCER</loadBalancerName>
<loadBalancerDomain>***.com</loadBalancerDomain>
<loadBalancerIpList>
<loadBalancerIp>**.*.*.*</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>*****</vpcNo>
<regionCode>KR</regionCode>
<subnetNoList>
<subnetNo>******</subnetNo>
</subnetNoList>
<loadBalancerSubnetList>
<loadBalancerSubnet>
<zoneCode>KR-1</zoneCode>
<subnetNo>******</subnetNo>
<publicIpInstanceNo></publicIpInstanceNo>
</loadBalancerSubnet>
</loadBalancerSubnetList>
<loadBalancerListenerNoList>
<loadBalancerListenerNo>******</loadBalancerListenerNo>
</loadBalancerListenerNoList>
</loadBalancerInstance>
</loadBalancerInstanceList>
</getLoadBalancerInstanceListResponse>