setTarget

Prev Next

VPC環境で利用できます。

概要

ターゲットグループに適用するターゲットを設定します。
過去に適用されたターゲットリストと関係なく、新たに指定したターゲット番号リストのみバインドされます。
ターゲット番号リストを指定しないと、過去にバインドされたターゲットリストがすべて除去されます。

リクエスト

リクエストパラメータ

パラメータ名 必須有無 タイプ 制約事項 説明
regionCode No String リージョンコード
ターゲットをバインドするターゲットグループのリージョン(Region)を決定できます。
regionCodeはgetRegionListアクションを通じて取得できます。
Default：getRegionList照会結果の最初のリージョンを選択
targetGroupNo Yes String ターゲットグループ番号
targetGroupNoはgetTargetGroupListアクションを通じて取得できます。
targetNoList.N No List<String> バインドするターゲット番号リスト
ターゲット番号リストを指定しないと、過去にバインドされたターゲットリストがすべて除去されます。
targetNoは、選択したターゲットグループのtargetTypeCodeに該当する照会アクションを通じて取得できます。
ex) targetNoList.1=1234&targetNoList.2=2345
responseFormatType No String レスポンス結果のフォーマットタイプ
Options : xml | json
Default : xml

レスポンス

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

  • TargetListタイプ
TargetList extends CommonResponse
private Integer totalRows;
private List targetList = new ArrayList<>();
Target
private String targetNo;
private String targetName;
private String targetIp;
private CommonCode healthCheckStatus;
private String healthCheckResponse;

例

リクエスト例

ncloud vloadbalancer setTarget --regionCode KR --targetGroupNo ***095 --targetNoList ***4299

レスポンス例

リクエスト実行後に当該ターゲットリストにバインドされたターゲットリスト

<setTargetResponse>
  <requestId>a4f8aa8d-aab1-4bb8-bad6-1d9006453945</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <targetList>
    <target>
      <targetNo>***4299</targetNo>
      <targetName>test-***</targetName>
      <targetIp>***.***.1.6</targetIp>
      <healthCheckStatus>
        <code>UNUSED</code>
        <codeName>unused Target</codeName>
      </healthCheckStatus>
      <healthCheckResponse></healthCheckResponse>
    </target>
  </targetList>
</setTargetResponse>