getLoadBalancerInstanceList

VPC 환경에서 이용 가능합니다.

개요

로드밸런서 인스턴스 리스트를 조회합니다.

요청

요청 파라미터

파라미터명	필수 여부	타입	설명
regionCode	No	String	- 리전 코드 로드밸런서 인스턴스 리스트가 조회될 리전(Region) 결정 regionCode는 getRegionList 액션을 통해서 획득 - Default : getRegionList 조회 결과의 첫 번째 리전을 선택
vpcNo	No	String	- VPC 번호 VPC 번호로 필터링하여 검색 vpcNo는 getVpcList 액션을 통해서 획득
loadBalancerTypeCode	No	String	- 로드밸런서 유형 코드 로드밸런서 유형으로 필터링하여 검색 Options : APPLICATION \| NETWORK \| NETWORK_PROXY
loadBalancerNetworkTypeCode	No	String	- 로드밸런서 네트워크 유형 코드 로드밸런서 네트워크 유형으로 필터링하여 검색 Options : PUBLIC \| PRIVATE
loadBalancerInstanceNoList.N	No	List<String>	- 로드밸런서 인스턴스 번호 리스트 로드밸런서 인스턴스 번호로 필터링하여 검색 loadBalancerInstanceNo는 getLoadBalancerInstanceList 액션을 통해서 획득 ex) loadBalancerInstanceNoList.1=1234&loadBalancerInstanceNoList.2=2345
pageNo	No	Integer	- 페이징된 결과의 페이지 번호 결과값을 pageNo, pageSize를 이용하여 페이징 처리 가능
pageSize	Conditional	Integer	- 페이징 시 보여줄 각 페이지 사이즈 결과값을 pageNo, pageSize를 이용하여 페이징 처리 가능 pageNo 입력시 반드시 입력
sortList.N.sortedBy	No	String	- 정렬 대상 결과값을 로드밸런서 이름으로 정렬 Options : loadBalancerName ex) sortList.1.sortedBy=loadBalancerName
sortList.N.sortingOrder	No	String	- 정렬 순서 sortedBy 이용시 오름차순/내림차순 정렬 설정 Options : ASC (오름차순) \| DESC (내림차순) Default : ASC ex) sortList.1.sortingOrder=DESC
responseFormatType	No	String	- 응답 결과의 포맷 타입 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>

Documentation Index

getLoadBalancerInstanceList

개요

요청

요청 파라미터

응답

응답 데이터 타입

예시

요청 예시

응답 예시