createTargetGroup

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

VPC環境で利用できます。

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

リクエスト

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

メソッド	URI
GET	/createTargetGroup

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	作成するターゲットグループのリージョンコード getRegionList照会結果の最初のリージョン(デフォルト) getRegionListを通じて確認
`vpcNo`	String	Required	作成するターゲットグループの VPC番号 getVpcListを通じて確認
`targetGroupName`	String	Optional	ターゲットグループの名前 NAVERクラウドプラットフォームが自動付与(デフォルト) 英数字、記号の「-」を使用して3~30文字以内で入力、先頭文字は英字のみを、末尾文字は英字または数字のみ使用
`targetTypeCode`	String	Optional	ターゲットグループに追加されるターゲットタイプ `VSVR` `VSVR`: Server (VPC)
`targetGroupProtocolTypeCode`	String	Required	ターゲットグループのプロトコルタイプ `HTTP` \| `HTTPS` \| `TCP` \| `UDP` \| `PROXY_TCP` 使用するプロトコルに応じて適用可能なロードバランサのタイプが制限されるアプリケーションロードバランサ: `HTTP` \| `HTTPS` ネットワークロードバランサ: `TCP` \| `UDP` ネットワークプロキシロードバランサ: `PROXY_TCP` `UDP`プロトコルはシンガポール、日本リージョンでのみ利用可能
`targetGroupPort`	Integer	Optional	ターゲットタイプで使用するポート 1~65534 (デフォルト: 80)
`targetGroupDescription`	String	Optional	ターゲットタイプの説明(Byte) 0~1,000
`healthCheckProtocolTypeCode`	String	Required	ターゲットの状態を確認するためのヘルスチェック実行時にロードバランサが使用するプロトコル `HTTP` \| `HTTPS` \| `TCP` ターゲットグループのプロトコルタイプに応じて選択可能な値が制限される `HTTP`、`HTTPS`プロトコル: `HTTP`、`HTTPS` `TCP`、`UDP`、`PROXY_TCP`プロトコル: `TCP`
`healthCheckPort`	Integer	Optional	ターゲットの状態を確認するためのヘルスチェック実行時にロードバランサが使用するポート 1~65534 (デフォルト: 80)
`healthCheckUrlPath`	String	Optional	ヘルスチェック実行時に使用する URLパス `/`(デフォルト) `/`で始まる URLパスターゲットグループのヘルスチェックプロトコルタイプが`HTTP`または`HTTPS`の場合、設定可能
`healthCheckHttpMethodTypeCode`	String	Conditional	ヘルスチェックに使用する HTTPメソッドタイプ `HEAD` \| `GET` ターゲットグループのヘルスチェックプロトコルタイプが`HTTP`または`HTTPS`の場合、必ず入力
`healthCheckCycle`	Integer	Optional	ヘルスチェック周期(秒) 5~300 (デフォルト: 30)
`healthCheckUpThreshold`	Integer	Optional	ターゲットの状態を正常と判断するために必要な連続ヘルスチェック成功回数 2~10 (デフォルト: 2)
`healthCheckDownThreshold`	Integer	Optional	ターゲットの状態を異常と判断するために必要な連続ヘルスチェック失敗回数 2~10 (デフォルト: 2)
`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/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>

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

What's Next

changeTargetGroupConfiguration

リクエスト
レスポンス

タグ

Load Balancer