getTargetList

VPC環境で利用できます。

ターゲットグループに適用されたターゲットリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/vloadbalancer/v2/getTargetList

リクエストヘッダ

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

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

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	ターゲットリストを照会する対象ターゲットグループのリージョンコード getRegionList照会結果の最初のリージョン(デフォルト) getRegionListを参照
`targetGroupNo`	String	Required	ターゲットグループの番号 getTargetGroupListを参照
`responseFormatType`	String	Optional	レスポンス結果の形式 `xml`(デフォルト) \| `json`

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

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

Load Balancer APIで共通して使用されるレスポンスステータスコードの詳細は、Load Balancerのレスポンスステータスコードをご参照ください。

レスポンス例

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

<getTargetListResponse>
    <requestId>450667dc-6b9b-449f-ac7a-931f318a528a</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <targetList>
        <target>
            <targetNo>********</targetNo>
            <targetName>YOUR_TARGET</targetName>
            <targetIp>***.***.*.*</targetIp>
            <healthCheckStatus>
                <code>DOWN</code>
                <codeName>Health DOWN state</codeName>
            </healthCheckStatus>
            <healthCheckResponse></healthCheckResponse>
        </target>
    </targetList>
</getTargetListResponse>