getLoadBalancerInstanceList

Prev Next

VPC環境で利用できます。

ユーザーが指定した条件に基づいて、ロードバランサインスタンスリストを照会します。

構文

getLoadBalancerInstanceList構文は次の通りです。

./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>]

オプション

getLoadBalancerInstanceListの実行時に指定できるオプションについて説明します。

必須オプション

getLoadBalancerInstanceListの必須オプションです。

オプション タイプ 必須の有無 説明
--pageSize Integer Conditional ページごとに表示する結果数
  • pageNo入力時、必ず入力
  • pageNo、pageSizeを利用して結果値をページング処理

任意オプション

getLoadBalancerInstanceListの任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

オプション タイプ 必須の有無 説明
--vpcNo String Optional VPC番号
--loadBalancerTypeCode String Optional ロードバランサのタイプ
  • APPLICATION | NETWORK | NETWORK_PROXY
    • APPLICATION: アプリケーションロードバランサ
    • NETWORK: ネットワークロードバランサ
    • NETWORK_PROXY: ネットワークプロキシロードバランサ
--loadBalancerNetworkTypeCode String Optional ロードバランサネットワークタイプ
  • PUBLIC | PRIVATE
--loadBalancerInstanceNoList List Optional ロードバランサインスタンス番号リスト
  • スペースで区切って複数入力可能 (例: --loadBalancerInstanceNoList 41112223 41112224)
--pageNo Integer Optional ページング処理された結果のページ番号
  • 1~N
  • pageNo、pageSizeを利用して結果値をページング処理
--sortList List Optional ソートの条件
  • 二重引用符の中に{フィールド=‘値’}のペアをコンマで区切って入力
    • sortedBy (任意): ソート順。loadBalancerName (ロードバランサ名)
    • sortingOrder (任意): ソート順。ASC (上昇、デフォルト) | DESC (下降)

共通オプション

vloadbalancerコマンドで共通して使用するオプションについては、Load Balancer (VPC)のオプションをご参照ください。

例

ロードバランサインスタンスリストの照会リクエストが成功すると、各インスタンスの構成情報が返されます。

コマンド

コマンドの例は次の通りです。

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

出力

出力の例は次の通りです。

{
  "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"
  }
}