getLoadBalancerInstanceList
    • PDF

    getLoadBalancerInstanceList

    • PDF

    記事の要約

    VPC環境で利用できます。

    概要

    ロードバランサインスタンスリストを照会します。

    リクエスト

    リクエストパラメータ

    パラメータ名必須有無タイプ制約事項説明
    regionCodeNoStringリージョンコード
    ロードバランサインスタンスリストが照会されるリージョン(Region)を決定できます。
    regionCodeはgetRegionListアクションを通じて取得できます。
    Default:getRegionList照会結果の最初のリージョンを選択
    vpcNoNoStringVPC番号
    VPC番号でフィルタリングして検索できます。
    vpcNoはgetVpcListアクションを通じて取得できます。
    loadBalancerTypeCodeNoStringロードバランサのタイプコード
    ロードバランサのタイプでフィルタリングして検索できます。
    Options : APPLICATION | NETWORK | NETWORK_PROXY
    loadBalancerNetworkTypeCodeNoStringロードバランサのネットワークタイプコード
    ロードバランサのネットワークタイプでフィルタリングして検索できます。
    Options : PUBLIC | PRIVATE
    loadBalancerInstanceNoList.NNoList<String>ロードバランサインスタンス番号リスト
    ロードバランサインスタンス番号でフィルタリングして検索できます。
    loadBalancerInstanceNoはgetLoadBalancerInstanceListアクションを通じて取得できます。
    ex) loadBalancerInstanceNoList.1=1234&loadBalancerInstanceNoList.2=2345
    pageNoNoIntegerページングされた結果のページ番号
    結果値をpageNo、pageSizeを用いてページング処理することができます。
    pageSizeConditionalIntegerページングする時に表示する各ページサイズ
    結果値をpageNo、pageSizeを用いてページング処理することができます。
    pageNoを入力する時、必ず入力します。
    sortList.N.sortedByNoStringソート対象
    結果値をロードバランサ名でソートできます。
    Options : loadBalancerName
    ex) sortList.1.sortedBy=loadBalancerName
    sortList.N.sortingOrderNoStringソート順序
    sortedByを利用する時、昇順/降順ソートを設定します。
    Options:ASC (昇順) | DESC (降順)
    Default : ASC
    ex) sortList.1.sortingOrder=DESC
    responseFormatTypeNoStringレスポンス結果のフォーマットタイプ
    Options : xml | json
    Default : xml

    レスポンス

    レスポンスデータのタイプ

    • LoadBalancerInstanceListタイプ
    LoadBalancerInstanceList extends CommonResponse
    private Integer totalRows;
    private List loadBalancerInstanceList = new ArrayList<>();
    LoadBalancerInstance
    private String loadBalancerInstanceNo;
    private CommonCode loadBalancerInstanceStatus;
    private CommonCode loadBalancerInstanceOperation;
    private String loadBalancerInstanceStatusName;
    private String loadBalancerDescription;
    private Date createDate;
    private String loadBalancerName;
    private String loadBalancerDomain;
    private LoadBalancerIpList loadBalancerIpList;
    private CommonCode loadBalancerType;
    private CommonCode loadBalancerNetworkType;
    private CommonCode throughputType;
    private Integer idleTimeout;
    private String vpcNo;
    private String regionCode;
    private SubnetNoList subnetNoList;
    private List<LoadBalancerSubnet> loadBalancerSubnetList;
    private LoadBalancerListenerNoList loadBalancerListenerNoList;
    LoadBalancerIpList
    private List loadBalancerIpList = new ArrayList<>();
    SubnetNoList
    private List subnetNoList = new ArrayList<>();
    LoadBalancerSubnet
    private String zoneCode;
    private String subnetNo;
    private String publicIpInstanceNo;
    LoadBalancerListenerNoList
    private List loadBalancerListenerNoList = new ArrayList<>();

    リクエスト例

    ncloud vloadbalancer getLoadBalancerInstanceList --regionCode KR --vpcNo ***04 --loadBalancerTypeCode APPLICATION --loadBalancerNetworkTypeCode PRIVATE --loadBalancerInstanceNoList ***887
    

    レスポンス例

    <getLoadBalancerInstanceListResponse>
      <requestId>959a2fe5-fd1b-459a-9af3-df0e51b68e1d</requestId>
      <returnCode>0</returnCode>
      <returnMessage>success</returnMessage>
      <totalRows>1</totalRows>
      <loadBalancerInstanceList>
        <loadBalancerInstance>
          <loadBalancerInstanceNo>***887</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>2020-12-20T19:21:02+0900</createDate>
          <loadBalancerName>test-***</loadBalancerName>
          <loadBalancerDomain>test-***-***887-***.com</loadBalancerDomain>
          <loadBalancerIpList>
            <loadBalancerIp>***.***.5.6</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>***04</vpcNo>
          <regionCode>KR</regionCode>
          <subnetNoList>
            <subnetNo>***43</subnetNo>
          </subnetNoList>
          <loadBalancerSubnetList>
            <loadBalancerSubnet>
              <zoneCode>KR-1</zoneCode>
              <subnetNo>***43</subnetNo>
              <publicIpInstanceNo/>
            </loadBalancerSubnet>
          </loadBalancerSubnetList>
          <loadBalancerListenerNoList>
            <loadBalancerListenerNo>***961</loadBalancerListenerNo>
          </loadBalancerListenerNoList>
        </loadBalancerInstance>
      </loadBalancerInstanceList>
    </getLoadBalancerInstanceListResponse>
    

    この記事は役に立ちましたか?

    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.