getLoadBalancerInstanceList

Prev Next

Available in VPC

Get the list of load balancer instances based on user-specified criteria.

Syntax

The getLoadBalancerInstanceList syntax is as follows:

./ncloud vloadbalancer getLoadBalancerInstanceList \
    [--vpcNo <vpc-no>] \
    [--loadBalancerTypeCode <APPLICATION|NETWORK|NETWORK_PROXY>] \
    [--loadBalancerNetworkTypeCode <PUBLIC|PRIVATE>] \
    [--loadBalancerInstanceNoList <load-balancer-instance-no-list>] \
    [--pageNo <page-no>] \
    [--pageSize <page-size>] \
    [--sortList <sort-condition>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running getLoadBalancerInstanceList.

Required options

The following options are required for getLoadBalancerInstanceList.

Options Type Required Description
--pageSize Integer Conditional Results to display per page
  • Required when specifying pageNo.
  • Uses pageNo and pageSize to paginate the results.

Optional options

These are the optional options for getLoadBalancerInstanceList. Options that are not specified will use their default values.

Options Type Required Description
--vpcNo String Optional VPC number
--loadBalancerTypeCode String Optional Load balancer type
  • APPLICATION | NETWORK | NETWORK_PROXY
    • APPLICATION: Application Load Balancer
    • NETWORK: Network Load Balancer
    • NETWORK_PROXY: Network Proxy Load Balancer
--loadBalancerNetworkTypeCode String Optional Load balancer network type
  • PUBLIC | PRIVATE
--loadBalancerInstanceNoList List Optional List of load balancer instance numbers
  • You can enter multiple items separated by spaces (e.g., --loadBalancerInstanceNoList 41112223 41112224).
--pageNo Integer Optional Page numbers in paged results
  • 1-N
  • Uses pageNo and pageSize to paginate the results.
--sortList List Optional Sort criteria
  • Enter {field='value'} pairs enclosed in quotation marks, separated by commas.
    • sortedBy (optional): Sort criteria. loadBalancerName (load balancer name).
    • sortingOrder (optional): Sort order. ASC (ascending, default) | DESC (descending).

Common options

For information about the options common to all vloadbalancer subcommands, see Load Balancer (VPC) options.

Examples

If the request to retrieve the list of load balancer instances is successful, the configuration information for each instance is returned.

Command

The command example is as follows:

./ncloud vloadbalancer getLoadBalancerInstanceList \
    --vpcNo 12345678 \
    --loadBalancerTypeCode APPLICATION \
    --loadBalancerNetworkTypeCode PRIVATE \
    --pageNo 1 \
    --pageSize 10 \
    --sortList "sortedBy='loadBalancerName',sortingOrder='ASC'" \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "getLoadBalancerInstanceListResponse": {
    "totalRows": 1,
    "loadBalancerInstanceList": [
      {
        "loadBalancerInstanceNo": "41112223",
        "loadBalancerInstanceStatus": {
          "code": "USED",
          "codeName": "LB USED state"
        },
        "loadBalancerInstanceOperation": {
          "code": "NULL",
          "codeName": "LB NULL OP"
        },
        "loadBalancerInstanceStatusName": "Running",
        "loadBalancerDescription": "Updated load balancer description",
        "createDate": "2026-07-07T17:12:11+0900",
        "loadBalancerName": "lb-test-01",
        "loadBalancerDomain": "lb-test-01-41112223-16dd7a5738c1.kr.lb.naverncp.com",
        "loadBalancerIpList": [
          "10.0.2.6",
          "10.0.3.6"
        ],
        "loadBalancerType": {
          "code": "APPLICATION",
          "codeName": "Application Load Balancer"
        },
        "loadBalancerNetworkType": {
          "code": "PRIVATE",
          "codeName": "Private"
        },
        "throughputType": {
          "code": "SMALL",
          "codeName": "Small"
        },
        "idleTimeout": 120,
        "vpcNo": "12345678",
        "regionCode": "KR",
        "accessLogUseYn": "N",
        "subnetNoList": [
          "23456790",
          "23456791"
        ],
        "loadBalancerSubnetList": [
          {
            "zoneCode": "KR-1",
            "subnetNo": "23456790",
            "publicIpInstanceNo": ""
          },
          {
            "zoneCode": "KR-2",
            "subnetNo": "23456791",
            "publicIpInstanceNo": ""
          }
        ],
        "loadBalancerListenerNoList": [
          "60001111"
        ]
      }
    ],
    "requestId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
    "returnCode": "0",
    "returnMessage": "success"
  }
}