- Print
- PDF
GetMetaLb
- Print
- PDF
The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.
Available in VPC
Get available Load Balancer information from the Network Traffic Monitoring service.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
GET | /meta/v1/lb |
Request headers
For information about the headers common to all Network Traffic Monitoring APIs, see Network Traffic Monitoring request headers.
Request query parameters
You can use the following query parameters with your request:
Field | Type | Required | Description |
---|---|---|---|
page | Integer | Required | Page number
|
size | Integer | Required | Page output count
|
ip | String | Optional | Load Balancer IP |
regionCode | String | Optional | Region code
|
Request example
The request example is as follows:
curl --location --request GET 'https://vpc-ntm.apigw.ntruss.com/meta/v1/lb?page=0&size=2' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'x-ncp-dmn_cd: PUB' \
Response
This section describes the response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
lbList | Array | - | Load Balancer list |
total | Integer | - | Number of response results |
lbList
The following describes lbList
.
Field | Type | Required | Description |
---|---|---|---|
networkTrafficMonitoringInstanceNo | Integer | - | Network Traffic Monitoring instance number |
subscribed | Boolean | - | Network Traffic Monitoring subscription status
|
See LoadBalancerInstance for more information about the fields related to Load Balancer information.
Response status codes
For information about the HTTP status codes common to all Network Traffic Monitoring APIs, see Network Traffic Monitoring response status codes.
Response example
The response example is as follows:
{
"lbList": [
{
"instanceNo": 1803849,
"loadBalancerName": "test-lb",
"regionNo": 1,
"regionCode": "KR",
"regionName": "Korea",
"instanceStatusCode": "USED",
"instanceStatusName": "Running",
"loadBalancerIpList": [
"***.***.***.***"
],
"ipTypeCode": "PUBLIC",
"networkTrafficMonitoringInstanceNo": null,
"subscribed": false
}
],
"total": 2
}