getTargetGroupList

Prev Next

VPC環境で利用できます。

概要

ターゲットグループリストを照会します。

リクエスト

リクエストパラメータ

パラメータ名 必須有無 タイプ 制約事項 説明
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 KR --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>KR</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>