changeTargetGroupConfiguration

Prev Next

VPC環境で利用できます。

概要

ターゲットグループの設定を変更します。

リクエスト

リクエストパラメータ

パラメータ名 必須有無 タイプ 制約事項 説明
regionCode No String リージョンコード
設定を変更するターゲットグループのリージョン(Region)を決定できます。
regionCodeはgetRegionListアクションを通じて取得できます。
Default：getRegionList照会結果の最初のリージョンを選択
targetGroupNo Yes String 設定を変更するターゲットグループ番号
targetGroupNoはgetTargetGroupListアクションを通じて取得できます。
useStickySession Conditional Boolean セッション別アクセスの使用の有無
選択したターゲットグループのタイプがTCP / HTTP / HTTPSである場合にのみ使用できます。
Options : true | false
useProxyProtocol Conditional Boolean プロキシプロトコルの使用の有無
選択したターゲットグループのタイプがPROXY_TCPである場合にのみ使用できます。
Options : true | false
algorithmTypeCode Conditional String アルゴリズムのタイプコード
ロードバランシングに使用するアルゴリズムのタイプを変更することができます。
Options :
RR (Round Robin)
SIPHS (Source IP Hash)
LC (Least Connection)
MH (Maglev Hash)
選択したターゲットグループのタイプに応じて設定可能なアルゴリズムのタイプが制限されます。
PROXY_TCP / HTTP / HTTPS : RR / SIPHS / LC
TCP : MH / RR
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 changeTargetGroupConfiguration --regionCode KR --targetGroupNo ***095 --useStickySession false --algorithmTypeCode RR

レスポンス例

<changeTargetGroupConfigurationResponse>
  <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>
</changeTargetGroupConfigurationResponse>