すべてのプロダクト
Search
ドキュメントセンター

:CreateServerGroup

最終更新日:Dec 21, 2025

Gateway Load Balancer (GWLB) インスタンスのサーバーグループを作成します。

操作説明

CreateServerGroup は非同期操作です。リクエストの送信後、システムはリクエスト ID を返し、バックグラウンドでタスクを実行します。ListServerGroups 操作を呼び出して、タスクのステータスをクエリできます。

  • サーバーグループが作成中ステータスの場合、サーバーグループが作成中であることを示します。

  • サーバーグループが利用可能ステータスの場合、サーバーグループが作成されたことを示します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

gwlb:CreateServerGroup

create

*ServerGroup

acs:gwlb:{#regionId}:{#accountId}:servergroup/*

*VPC

acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

ServerGroupType

string

任意

サーバーグループのタイプ。有効な値:

  • Instance (デフォルト):ECSENI、または ECI タイプのリソースを指定できます。

  • Ip:IP アドレスを指定してサーバーを追加できます。

Instance

ServerGroupName

string

任意

サーバーグループ名。

名前は 2~128 文字で、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。先頭は英字である必要があります。

testServerGroupName

Protocol

string

任意

バックエンドプロトコル。有効な値:

  • GENEVE (デフォルト)

列挙値:

  • GENEVE :

    GENEVE

GENEVE

Scheduler

string

任意

スケジューリングアルゴリズム。有効な値:

  • 5TCH (デフォルト):送信元 IP アドレス、宛先 IP アドレス、送信元ポート、プロトコル、宛先ポートの 5 つの要素に基づく一貫性ハッシュを指定します。前述の要素に基づく同じ情報を含むリクエストは、同じバックエンドサーバーに転送されます。

  • 3TCH:送信元 IP アドレス、宛先 IP アドレス、プロトコルの 3 つの要素に基づく一貫性ハッシュを指定します。前述の要素に基づく同じ情報を含むリクエストは、同じバックエンドサーバーに転送されます。

  • 2TCH:送信元 IP アドレスと宛先 IP アドレスの 2 つの要素に基づく一貫性ハッシュを指定します。前述の要素に基づく同じ情報を含むリクエストは、同じバックエンドサーバーに転送されます。

5TCH

ServerFailoverMode

string

任意

バックエンドサーバーが正常に動作していない場合に、GWLB が既存の接続を介してリクエストを処理する方法を指定します。有効な値:

  • NoRebalance (デフォルト):GWLB は、利用できないバックエンドサーバーへの既存の接続を介してリクエストを転送し続けます。

  • Rebalance:GWLB は、残りの正常なバックエンドサーバーへの既存の接続を介してリクエストを転送します。

NoRebalance

VpcId

string

必須

VPC ID。

説明

ServerGroupTypeInstance に設定されている場合、指定された VPC 内のサーバーのみをサーバーグループに追加できます。

vpc-bp15zckdt37pq72zv****

ResourceGroupId

string

任意

リソースグループ ID。

rg-atstuj3rtop****

ConnectionDrainConfig

object

任意

接続ドレインの構成。

ConnectionDrainEnabled

boolean

任意

接続ドレインを有効にするかどうかを指定します。有効な値:

  • true

  • false

false

ConnectionDrainTimeout

integer

任意

接続ドレインのタイムアウト期間。

単位:秒

有効な値:13600

デフォルト値:300

300

HealthCheckConfig

object

任意

ヘルスチェックの構成。

HealthCheckConnectPort

integer

任意

ヘルスチェックに使用されるバックエンドサーバーのポート。

有効な値:165535

デフォルト値:80

80

HealthCheckConnectTimeout

integer

任意

ヘルスチェック応答の最大タイムアウト期間。

単位:秒。

有効な値:1300

デフォルト値:5

5

HealthCheckDomain

string

任意

ヘルスチェックに使用されるドメイン名。有効な値:

  • $SERVER_IP (デフォルト):バックエンドサーバーのプライベート IP アドレス。

  • domain:ドメイン名。ドメイン名は 1~80 文字で、英字、数字、ハイフン (-)、ピリオド (.) を使用できます。

説明

このパラメーターは、HealthCheckProtocolHTTP に設定した場合にのみ有効になります。

$SERVER_IP

HealthCheckEnabled

boolean

任意

ヘルスチェックを有効にするかどうかを指定します。有効な値:

  • true (デフォルト)

  • false

true

HealthCheckHttpCode

array

任意

システムがヘルスチェックに対して返す HTTP ステータスコード。

string

任意

ヘルスチェックに対して返される HTTP ステータスコード。複数の HTTP ステータスコードはコンマ (,) で区切ります。有効な値:

  • http_2xx

  • http_3xx

  • http_4xx

  • http_5xx

デフォルト値:http_2xx

説明

このパラメーターは、HealthCheckProtocolHTTP に設定した場合にのみ有効になります。

http_2xx

HealthCheckInterval

integer

任意

ヘルスチェックが実行される間隔。

単位:秒。

有効な値:150

デフォルト値:10

10

HealthCheckPath

string

任意

ヘルスチェックに使用されるパス。

長さは 1~80 文字で、英字、数字、ハイフン (-)、スラッシュ (/)、ピリオド (.)、パーセント記号 (%)、疑問符 (?)、番号記号 (#)、アンパサンド (&) を使用できます。URL には、次の拡張文字も使用できます:_ ; ~ ! ( ) * [ ] @ $ ^ : ' , + =

先頭はスラッシュ (/) である必要があります。

説明

このパラメーターは、HealthCheckProtocolHTTP に設定した場合にのみ有効になります。

/test/index.html

HealthCheckProtocol

string

任意

ヘルスチェックに使用されるプロトコル。有効な値:

  • TCP (デフォルト):GWLB は、バックエンドサーバーに SYN パケットを送信して TCP ヘルスチェックを実行し、バックエンドサーバーのポートがリクエストを受信できるかどうかを確認します。

  • HTTP:GWLB は、ブラウザからのアクセスをシミュレートする GET リクエストを送信して HTTP ヘルスチェックを実行し、バックエンドサーバーが正常であるかどうかを確認します。

TCP

HealthyThreshold

integer

任意

異常なバックエンドサーバーが正常と判断されるまでに連続してヘルスチェックに合格する必要がある回数。この場合、バックエンドサーバーのヘルスチェックステータスは fail から success に変わります。

有効な値:210

デフォルト値:2

2

UnhealthyThreshold

integer

任意

正常なバックエンドサーバーが異常と判断されるまでに連続してヘルスチェックに失敗する必要がある回数。この場合、バックエンドサーバーのヘルスチェックステータスは success から fail に変わります。

有効な値:210

デフォルト値:2

2

Tag

array<object>

任意

タグキー。

各呼び出しで最大 20 個のタグを指定できます。

object

任意

タグ。

Key

string

任意

タグキー。タグキーは空の文字列にできません。タグキーは最大 128 文字で、acs: または aliyun で始めることはできません。タグキーに http:// または https:// を含めることはできません。

testTagKey

Value

string

任意

タグ値。タグ値は最大 256 文字で、http:// または https:// を含めることはできません。

testTagValue

DryRun

boolean

任意

実際のリクエストを実行せずに、ドライランのみを実行するかどうかを指定します。有効な値:

  • true:ドライランのみを実行します。システムは、パラメーター値の欠落、不正なリクエスト構文、サービスの制限など、リクエストに潜在的な問題がないかチェックします。リクエストがドライランに失敗した場合、エラーコードが返されます。リクエストがドライランに合格した場合、DryRunOperation エラーコードが返されます。

  • false (デフォルト):ドライランを実行し、実際のリクエストを実行します。リクエストがドライランに合格した場合、2xx HTTP ステータスコードが返され、操作が実行されます。

False

ClientToken

string

任意

リクエストのべき等性を保証するために使用されるクライアントトークン。

クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。クライアントトークンには ASCII 文字のみを含めることができます。

説明

このパラメーターを指定しない場合、システムは自動的にリクエスト IDクライアントトークンとして使用します。リクエスト ID はリクエストごとに異なる場合があります。

123e4567-e89b-12d3-a456-42665544****

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエスト ID。

54B48E3D-DF70-471B-AA93-08E683A1B45

ServerGroupId

string

サーバーグループ ID。

sgp-atstuj3rtoptyui****

成功レスポンス

JSONJSON

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "ServerGroupId": "sgp-atstuj3rtoptyui****"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 IllegalParam.HealthCheckProtocol The param of %s is illegal.
400 QuotaExceeded.ServerGroupsNum The quota of %s is exceeded for resource %s, usage %s/%s.
400 DuplicatedParam.TagKey The param of %s is duplicated.
400 IllegalParam.TagKey The param of %s is illegal.
404 ResourceNotFound.Vpc The specified resource of %s is not found.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。