getTargetGroupList

개요

타겟 그룹 리스트를 조회합니다.

요청

요청 파라미터

파라미터명	필수 여부	타입	설명
regionCode	No	String	- 리전 코드 타겟 그룹 리스트가 조회될 리전(Region)을 결정 가능 regionCode는 getRegionList 액션을 통해서 획득 가능 Default : getRegionList 조회 결과의 첫 번째 리전 선택
vpcNo	No	String	- VPC 번호 VPC 번호로 필터링하여 검색 가능 vpcNo는 getVpcList 액션을 통해서 획득 가능
targetTypeCode	No	String	- 타겟 유형 코드 타겟 유형 코드로 필터링하여 검색 가능 Options : VSVR (Server (VPC))
targetGroupNoList.N	No	List<String>	- 타겟 그룹 번호 리스트 타겟 그룹 번호로 필터링하여 검색 가능 targetGroupNo는 getTargetGroupList 액션을 통해서 획득 가능 ex) targetGroupNoList.1=1234&targetGroupNoList.2=2345
pageNo	No	Integer	- 페이징된 결과의 페이지 번호 결과값을 pageNo, pageSize를 이용하여 페이징 처리 가능
pageSize	Conditional	Integer	- 페이징 시 보여줄 각 페이지 사이즈 결과값을 pageNo, pageSize를 이용하여 페이징 처리 가능 pageNo 입력 시 반드시 입력해야 함
sortList.N.sortedBy	No	String	- 정렬 대상 결과값을 타겟 그룹 번호, 타겟 그룹 이름으로 정렬 가능 Options : targetGroupNo \| targetGroupName ex) sortList.1.sortedBy=targetGroupNo
sortList.N.sortingOrder	No	String	- 정렬 순서 sortedBy 이용시 오름차순/내림차순 정렬을 설정 가능 Options : ASC (오름차순) \| DESC (내림차순) Default : ASC ex) sortList.1.sortingOrder=DESC
responseFormatType	No	String	- 응답 결과의 포맷 타입 Options: xml \| json Default : xml

응답

응답 데이터 타입

TargetGroupList 타입

TargetGroupList extends CommonResponse
private Integer totalRows;
private List targetGroupList = new ArrayList<>();

TargetGroup
private String targetGroupNo;
private String targetGroupName;
private CommonCode targetType;
private String vpcNo;
private CommonCode targetGroupProtocolType;
private Integer targetGroupPort;
private String targetGroupDescription;
private Boolean useStickySession;
private Boolean useProxyProtocol;
private CommonCode algorithmType;
private Date createDate;
private String regionCode;
private String loadBalancerInstanceNo;
private CommonCode healthCheckProtocolType;
private Integer healthCheckPort;
private String healthCheckUrlPath;
private CommonCode healthCheckHttpMethodType;
private Integer healthCheckCycle;
private Integer healthCheckUpThreshold;
private Integer healthCheckDownThreshold;
private TargetNoList targetNoList;

TargetNoList
private List targetNoList = new ArrayList<>();

예시

요청 예시

ncloud vloadbalancer getTargetGroupList --regionCode FKR --vpcNo ***04 --targetTypeCode VSVR --targetGroupNoList ***095

응답 예시

<getTargetGroupListResponse>
  <requestId>b644e5ed-6ca8-48d5-9b7f-2a3549ef3c96</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <targetGroupList>
    <targetGroup>
      <targetGroupNo>***095</targetGroupNo>
      <targetGroupName>test-***</targetGroupName>
      <targetType>
        <code>VSVR</code>
        <codeName>Server (VPC)</codeName>
      </targetType>
      <vpcNo>***04</vpcNo>
      <targetGroupProtocolType>
        <code>HTTP</code>
        <codeName>HTTP protocol</codeName>
      </targetGroupProtocolType>
      <targetGroupPort>80</targetGroupPort>
      <targetGroupDescription></targetGroupDescription>
      <useStickySession>false</useStickySession>
      <useProxyProtocol>false</useProxyProtocol>
      <algorithmType>
        <code>RR</code>
        <codeName>Round Robin</codeName>
      </algorithmType>
      <createDate>2020-12-17T21:06:45+0900</createDate>
      <regionCode>FKR</regionCode>
      <loadBalancerInstanceNo></loadBalancerInstanceNo>
      <healthCheckProtocolType>
        <code>HTTP</code>
        <codeName>HTTP protocol</codeName>
      </healthCheckProtocolType>
      <healthCheckPort>80</healthCheckPort>
      <healthCheckUrlPath>/</healthCheckUrlPath>
      <healthCheckHttpMethodType>
        <code>GET</code>
        <codeName>get</codeName>
      </healthCheckHttpMethodType>
      <healthCheckCycle>30</healthCheckCycle>
      <healthCheckUpThreshold>2</healthCheckUpThreshold>
      <healthCheckDownThreshold>2</healthCheckDownThreshold>
      <targetNoList/>
    </targetGroup>
  </targetGroupList>
</getTargetGroupListResponse>