getTargetGroupList

Prev Next

VPC環境で利用できます。

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

リクエスト

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

メソッド URI
GET /getTargetGroupList

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リスト照会対象のターゲットグループのリージョンコード
  • getRegionList照会結果の最初のリージョン(デフォルト)
  • getRegionListを通じて確認
vpcNo String Optional リスト照会対象のターゲットグループの VPC番号
targetTypeCode String Optional ターゲットタイプ
  • VSVR
    • VSVR: Server (VPC)
targetGroupNoList.N List<String> Optional ターゲットグループの番号リスト
  • targetGroupNoはgetTargetGroupListを通じて確認
  • <例> targetGroupNoList.1=1234&targetGroupNoList.2=2345
pageNo Integer Optional ページング処理された結果のページ番号
pageSize Integer Conditional ページごとに表示する結果数
  • pageNo入力時、必須
sortList.N.sortedBy String Optional ソート基準
  • targetGroupNo | targetGroupName
    • targetGroupNo: ターゲットグループの番号
    • targetGroupName: ターゲットグループの名前
  • <例> sortList.1.sortedBy=targetGroupNo
sortList.N.sortingOrder String Optional ソート順序
  • ASC(デフォルト) | DESC
    • ASC: 昇順
    • DESC: 降順
  • <例> sortList.1.sortingOrder=DESC
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

<getTargetGroupListResponse>
    <requestId>875c17ee-75cd-4bec-a0bd-1bac824d779f</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <targetGroupList>
        <targetGroup>
            <targetGroupNo>*******</targetGroupNo>
            <targetGroupName>YOUR_TARGET_GROUP</targetGroupName>
            <targetType>
                <code>VSVR</code>
                <codeName>Server (VPC)</codeName>
            </targetType>
            <vpcNo>*****</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>2024-06-03T17:09:27+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>HTTP GET Method</codeName>
            </healthCheckHttpMethodType>
            <healthCheckCycle>30</healthCheckCycle>
            <healthCheckUpThreshold>2</healthCheckUpThreshold>
            <healthCheckDownThreshold>2</healthCheckDownThreshold>
            <targetNoList/>
        </targetGroup>
    </targetGroupList>
</getTargetGroupListResponse>