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

:CreateServerGroup

最終更新日:Mar 20, 2026

ロードバランシング用のサーバーグループを作成します。

操作説明

CreateServerGroup API は非同期処理です。API を呼び出すと、システムはリクエスト ID を返し、バックグラウンドでサーバーグループの作成を開始します。作成状況を確認するには、ListServerGroups API を呼び出してサーバーグループのステータスを照会してください:

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

  • Available ステータス:サーバーグループの作成が完了したことを示します。

今すぐお試しください

この 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(デフォルト):インスタンスベースのサーバーグループです。ECS、ENI、ECI の各インスタンスをこのタイプのサーバーグループに追加できます。

  • Ip:IP アドレスベースのサーバーグループです。バックエンドサーバーの IP アドレスを指定することで、このタイプのサーバーグループにバックエンドサーバーを追加できます。

Instance

ServerGroupName

string

任意

サーバーグループの名前。

名前の長さは 2~128 文字で、英字または漢字で始める必要があります。また、数字、ピリオド(.)、アンダースコア(_)、ハイフン(-)を含めることができます。

testServerGroupName

Protocol

string

任意

バックエンドサーバーで使用するプロトコル。有効な値は以下のとおりです:

  • GENEVE(デフォルト)。

列挙値:

  • GENEVE :

    GENEVE

GENEVE

Scheduler

string

任意

スケジューリングアルゴリズム。有効な値は以下のとおりです:

  • 5TCH(デフォルト):5 次元ルール(送信元 IP、送信先 IP、送信元ポート、送信先ポート、プロトコル)に基づく一貫性ハッシュです。同じ 5 次元ルールを持つフローは、同一のバックエンドサーバーにルーティングされます。

  • 3TCH:3 次元ルール(送信元 IP、送信先 IP、プロトコル)に基づく一貫性ハッシュです。同じ 3 次元ルールを持つフローは、同一のバックエンドサーバーにルーティングされます。

  • 2TCH:2 次元ルール(送信元 IP、送信先 IP)に基づく一貫性ハッシュです。同じ 2 次元ルールを持つフローは、同一のバックエンドサーバーにルーティングされます。

5TCH

ServerFailoverMode

string

任意

バックエンドサーバーが不健全になった場合の既存接続の処理方法。有効な値は以下のとおりです:

  • NoRebalance(デフォルト):既存接続の再バランス調整を行いません。

  • Rebalance:既存接続の再バランス調整を行います。

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_2xx

  • http_3xx

  • http_4xx

  • http_5xx

デフォルト値: http_2xx

説明

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

http_2xx

HealthCheckInterval

integer

任意

ヘルスチェックの間隔。

単位:秒。

有効な値: 150

デフォルト値: 10

10

HealthCheckPath

string

任意

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

パスの長さは 1~80 文字で、先頭はスラッシュ(/)で始める必要があります。また、英字、数字、および以下の特殊文字を含めることができます:- / . % ? # & _;~!()*[]@$^:',+=

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

説明

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

/test/index.html

HealthCheckProtocol

string

任意

ヘルスチェックに使用するプロトコル。有効な値は以下のとおりです:

  • TCP(デフォルト):システムは SYN パケットをサーバーに送信して、ポートがリッスン状態であるかどうかを確認します。

  • HTTP:システムは GET リクエストをサーバーに送信して、アプリケーションが応答可能かどうかを確認します。

TCP

HealthyThreshold

integer

任意

バックエンドサーバーを「健全」と見なすために必要な、連続した成功ヘルスチェックの回数(「不健全」から「健全」へと状態が変化した後)。

有効な値: 210

デフォルト値: 2

2

UnhealthyThreshold

integer

任意

バックエンドサーバーを「不健全」と見なすために必要な、連続した失敗ヘルスチェックの回数(「健全」から「不健全」へと状態が変化した後)。

有効な値: 210

デフォルト値: 2

2

HealthCheckReq

string

任意

HealthCheckExp

string

任意

Tag

array<object>

任意

タグ。

1 回のリクエストで最大 20 個のタグを指定できます。

object

任意

タグ。

Key

string

任意

タグキー。空文字列にすることはできません。長さは最大 128 文字で、aliyunacs: で始めてはならず、http://https:// を含めてはなりません。

testTagKey

Value

string

任意

タグ値。長さは最大 256 文字で、http://https:// を含めてはなりません。

testTagValue

DryRun

boolean

任意

ドライランを実行するかどうかを指定します。有効な値は以下のとおりです:

  • true:必須パラメーター、リクエストフォーマット、サービス制限などの潜在的な問題を検証するためのドライランを実行します。このリクエストではサーバーグループは作成されません。検証に失敗した場合はエラーメッセージが返されます。検証に成功した場合は、DryRunOperation エラーコードが返されます。

  • false(デフォルト):通常のリクエストを送信します。リクエストが検証を通過すると、システムは HTTP 2xx ステータスコードを返し、操作を実行します。

False

ClientToken

string

任意

クライアントが生成する、グローバルに一意なトークンで、リクエストのべき等性を保証するために使用されます。

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

説明

このパラメーターを指定しない場合、システムは自動的に API リクエストの RequestIdClientToken として使用します。RequestId は各 API リクエストに対して一意です。

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.

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

変更履歴

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