setTarget

Prev Next

VPC環境で利用できます。

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

リクエストヘッダ

Load Balancer APIで共通して使用されるヘッダの詳細は、Load Balancerの共通ヘッダをご参照ください。

リクエストクエリパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
regionCode String Optional ターゲットをバインドする対象ターゲットグループのリージョンコード
  • getRegionList照会結果の最初のリージョン(デフォルト)
  • getRegionListを通じて確認
targetGroupNo String Required ターゲットグループの番号
targetNoList.N List<String> Optional バインド対象のターゲット番号リスト
  • ターゲット番号リストを指定しない場合、現在バインドされているターゲットリストがすべて削除される
  • targetNoはターゲットグループのtargetTypeCodeを通じて確認
  • <例> targetNoList.1=1234&targetNoList.2=2345
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location 'https://ncloud.apigw.ntruss.com/vloadbalancer/v2/setTarget
?regionCode=KR
&targetGroupNo=*******
&targetNoList.1=********'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの詳細は、TargetListをご参照ください。

レスポンスステータスコード

NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

<setTargetResponse>
    <requestId>6fbfbb6b-3ae7-4637-baba-521e1866108f</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <targetList>
        <target>
            <targetNo>********</targetNo>
            <targetName>YOUR_TARGET</targetName>
            <targetIp>***.***.*.*</targetIp>
            <healthCheckStatus>
                <code>UNUSED</code>
                <codeName>unused Target</codeName>
            </healthCheckStatus>
            <healthCheckResponse></healthCheckResponse>
        </target>
    </targetList>
</setTargetResponse>