createTargetGroup
    • PDF

    createTargetGroup

    • PDF

    記事の要約

    VPC環境で利用できます。

    ターゲットグループを作成します。作成されたターゲットグループはロードバランサまたはオートスケールグループで使用できます。

    リクエスト

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

    メソッドURI
    GET/createTargetGroup

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    regionCodeStringOptional作成するターゲットグループのリージョンコード
    • getRegionList照会結果の最初のリージョン(デフォルト)
    • getRegionListを通じて確認
    vpcNoStringRequired作成するターゲットグループの VPC番号
    targetGroupNameStringOptionalターゲットグループの名前
    • NAVERクラウドプラットフォームが自動付与(デフォルト)
    • 英数字、記号の「-」を使用して3~30文字以内で入力、先頭文字は英字のみを、末尾文字は英字または数字のみ使用
    targetTypeCodeStringOptionalターゲットグループに追加されるターゲットタイプ
    • VSVR
      • VSVR: Server (VPC)
    targetGroupProtocolTypeCodeStringRequiredターゲットグループのプロトコルタイプ
    • HTTP | HTTPS | TCP | UDP | PROXY_TCP
    • 使用するプロトコルに応じて適用可能なロードバランサのタイプが制限される
      • アプリケーションロードバランサ: HTTP | HTTPS
      • ネットワークロードバランサ: TCP | UDP
      • ネットワークプロキシロードバランサ: PROXY_TCP
    • UDPプロトコルはシンガポール、日本リージョンでのみ利用可能
    targetGroupPortIntegerOptionalターゲットタイプで使用するポート
    • 1~65534 (デフォルト: 80)
    targetGroupDescriptionStringOptionalターゲットタイプの説明(Byte)
    • 0~1,000
    healthCheckProtocolTypeCodeStringRequiredターゲットの状態を確認するためのヘルスチェック実行時にロードバランサが使用するプロトコル
    • HTTP | HTTPS | TCP
    • ターゲットグループのプロトコルタイプに応じて選択可能な値が制限される
      • HTTPHTTPSプロトコル: HTTPHTTPS
      • TCPUDPPROXY_TCPプロトコル: TCP
    healthCheckPortIntegerOptionalターゲットの状態を確認するためのヘルスチェック実行時にロードバランサが使用するポート
    • 1~65534 (デフォルト: 80)
    healthCheckUrlPathStringOptionalヘルスチェック実行時に使用する URLパス
    • /(デフォルト)
    • /で始まる URLパス
    • ターゲットグループのヘルスチェックプロトコルタイプがHTTPまたはHTTPSの場合、設定可能
    healthCheckHttpMethodTypeCodeStringConditionalヘルスチェックに使用する HTTPメソッドタイプ
    • HEAD | GET
    • ターゲットグループのヘルスチェックプロトコルタイプがHTTPまたはHTTPSの場合、必ず入力
    healthCheckCycleIntegerOptionalヘルスチェック周期(秒)
    • 5~300 (デフォルト: 30)
    healthCheckUpThresholdIntegerOptionalターゲットの状態を正常と判断するために必要な連続ヘルスチェック成功回数
    • 2~10 (デフォルト: 2)
    healthCheckDownThresholdIntegerOptionalターゲットの状態を異常と判断するために必要な連続ヘルスチェック失敗回数
    • 2~10 (デフォルト: 2)
    targetNoList.NList<String>Optionalターゲットグループにバインドするターゲットリスト
    • targetNotargetTypeCodeを通じて確認
    • <例> targetNoList.1=1234&targetNoList.2=2345
    responseFormatTypeStringOptionalレスポンス結果の形式
    • xml(デフォルト) | json

    リクエスト例

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

    curl --location 'https://ncloud.apigw.ntruss.com/vloadbalancer/v2/createTargetGroup
    ?regionCode=KR
    &vpcNo=*****
    &targetGroupName=YOUR_TARGET_GROUP
    &targetTypeCode=VSVR
    &targetGroupProtocolTypeCode=HTTP
    &targetGroupPort=80
    &healthCheckProtocolTypeCode=HTTP
    &healthCheckPort=80
    &healthCheckUrlPath=/
    &healthCheckHttpMethodTypeCode=GET
    &healthCheckCycle=30
    &healthCheckUpThreshold=2
    &healthCheckDownThreshold=2'
    --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のレスポンスステータスコードをご参照ください。

    レスポンス例

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

    <createTargetGroupResponse>
        <requestId>f5356756-9e75-4e69-94a8-8c88e270b5d2</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-04T10:17:10+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>
    </createTargetGroupResponse>
    

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.