GetMetaLb
    • PDF

    GetMetaLb

    • PDF

    Article summary

    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:

    MethodURI
    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:

    FieldTypeRequiredDescription
    pageIntegerRequiredPage number
    • 0 - N
    sizeIntegerRequiredPage output count
    • 1 - 100
    ipStringOptionalLoad Balancer IP
    regionCodeStringOptionalRegion code
    • KR (default)

    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:

    FieldTypeRequiredDescription
    lbListArray-Load Balancer list
    totalInteger-Number of response results

    lbList

    The following describes lbList.

    FieldTypeRequiredDescription
    networkTrafficMonitoringInstanceNoInteger-Network Traffic Monitoring instance number
    subscribedBoolean-Network Traffic Monitoring subscription status
    • true | false
      • true: subscribed
      • false: not subscribed
    Note

    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
    }
    

    Was this article helpful?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.