CreateServerGroup - - Alibaba Cloud ドキュメントセンター

リージョンにサーバーグループを作成します。

操作説明

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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

alb:CreateServerGroup

create

*ServerGroup

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

alb:ServerGroupProtocol

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ServerGroupName	string	必須	サーバーグループの名前。名前は長さが 2～128 文字で、英字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。名前は英字で始まる必要があります。	sg-atstuj3rtoptyui****
ServerGroupType	string	任意	サーバーグループのタイプ。有効値： Instance (デフォルト)：Ecs、Eni、または Eci を指定してサーバーを追加できます。 Ip：IP アドレスを指定してサーバーを追加できます。 Fc：Function Compute の関数を指定してサーバーを追加できます。	Instance
VpcId	string	任意	Virtual Private Cloud (VPC) の ID。指定された VPC にデプロイされているサーバーのみをサーバーグループに追加できます。説明このパラメーターは、ServerGroupType パラメーターが Instance または Ip に設定されている場合に有効になります。	vpc-bp15zckdt37pq72zv****
Scheduler	string	任意	スケジューリングアルゴリズム。有効値： Wrr (デフォルト)：重み付きラウンドロビンアルゴリズムが使用されます。重みが大きいバックエンドサーバーは、重みが小さいバックエンドサーバーよりも多くのリクエストを受信します。 Wlc：重み付き最小接続アルゴリズムが使用されます。リクエストは、重みとバックエンドサーバーへの接続数に基づいて分散されます。2 つのバックエンドサーバーの重みが同じ場合、接続数が少ないバックエンドサーバーがより多くのリクエストを受信することが期待されます。 Sch：一貫性ハッシュアルゴリズムが使用されます。同じ送信元 IP アドレスからのリクエストは、同じバックエンドサーバーに分散されます。説明このパラメーターは、ServerGroupType パラメーターが Instance または Ip に設定されている場合に有効になります。	Wrr
Protocol	string	任意	バックエンドプロトコル。有効値： HTTP：HTTPS、HTTP、または QUIC リスナーをサーバーグループに関連付けることができます。これはデフォルト値です。 HTTPS：HTTPS リスナーをバックエンドサーバーに関連付けることができます。 gRPC：HTTPS または QUIC リスナーをサーバーグループに関連付けることができます。説明 ServerGroupType を Fc に設定した場合、バックエンドプロトコルを指定する必要はありません。	HTTP
ResourceGroupId	string	任意	リソースグループの ID。	rg-atstuj3rtop****
HealthCheckConfig	object	必須	ヘルスチェック機能の設定。
HealthCheckConnectPort	integer	任意	ヘルスチェックに使用されるバックエンドポート。有効値：0～65535 デフォルト値は 0 で、バックエンドサーバーのポートがヘルスチェックに使用されることを指定します。	80
HealthCheckEnabled	boolean	必須	ヘルスチェック機能を有効にするかどうかを指定します。有効値： true false 説明 ServerGroupType パラメーターが Instance または Ip に設定されている場合、ヘルスチェック機能はデフォルトで有効になります。ServerGroupType パラメーターが Fc に設定されている場合、ヘルスチェック機能はデフォルトで無効になります。	true
HealthCheckHost	string	任意	ヘルスチェックに使用されるドメイン名。バックエンドサーバーの内部 IP (デフォルト)：バックエンドサーバーの内部 IP アドレスをヘルスチェックドメイン名として使用します。カスタムドメイン名：ドメイン名を入力します。ドメイン名は 1～80 文字の長さである必要があります。ドメイン名には、小文字の英字、数字、ハイフン (-)、ピリオド (.) を使用できます。ドメイン名には少なくとも 1 つのピリオド (.) を含める必要がありますが、ピリオド (.) で開始または終了することはできません。ドメイン名の最も右側のドメインラベルには英字のみを含めることができ、数字やハイフン (-) を含めることはできません。ドメイン名はハイフン (-) で開始または終了することはできません。説明このパラメーターは、HealthCheckProtocol が HTTP、HTTPS、または gRPC に設定されている場合にのみ有効です。	www.example.com
HealthCheckCodes	array	任意	正常なバックエンドサーバーを示す HTTP ステータスコード。
	string	任意	正常なバックエンドサーバーを示す HTTP ステータスコード。 HealthCheckProtocol が HTTP または HTTPS に設定されている場合、HealthCheckCodes を http_2xx (デフォルト値)、http_3xx、http_4xx、および http_5xx に設定できます。複数の HTTP ステータスコードはコンマ (,) で区切ります。 HealthCheckProtocol が gRPC に設定されている場合、HealthCheckCodes の有効値は 0～99 です。デフォルト値は 0 です。値の範囲がサポートされています。最大 20 個の値の範囲を指定できます。複数の値の範囲はコンマ (,) で区切ります。説明このパラメーターは、HealthCheckProtocol が HTTP、HTTPS、または gRPC に設定されている場合にのみ有効です。	http_2xx
HealthCheckHttpVersion	string	任意	HTTP プロトコルのバージョン。有効値：HTTP1.0 および HTTP1.1。デフォルト値：HTTP1.1。説明このパラメーターは、HealthCheckProtocol が HTTP または HTTPS に設定されている場合にのみ有効です。	HTTP1.1
HealthCheckInterval	integer	任意	ヘルスチェックが実行される間隔。単位：秒有効値：1～50 デフォルト値：2。	2
HealthCheckMethod	string	任意	ヘルスチェックに使用される HTTP メソッド。有効値： GET：レスポンスの長さが 8 KB を超える場合、レスポンスは切り捨てられます。ただし、ヘルスチェックの結果には影響しません。 POST：デフォルトでは、gRPC ヘルスチェックは POST メソッドを使用します。 HEAD (デフォルト)：デフォルトでは、HTTP および HTTPS は HEAD メソッドを使用します。説明このパラメーターは、HealthCheckProtocol が HTTP、HTTPS、または gRPC に設定されている場合にのみ有効です。	HEAD
HealthCheckPath	string	任意	ヘルスチェックに使用される URL。 URL は 1～80 文字の長さで、英字、数字、および次の特殊文字を含めることができます：`- / . % ? # & =`。また、次の拡張文字を含めることもできます：`_ ; ~ ! ( ) * [ ] @ $ ^ : ' , +`。URL はスラッシュ (/) で始まる必要があります。説明このパラメーターは、HealthCheckProtocol が HTTP または HTTPS に設定されている場合にのみ有効です。	/test/index.html
HealthCheckProtocol	string	任意	ヘルスチェックに使用されるプロトコル。有効値： HTTP：HTTP ヘルスチェックは、HEAD または GET リクエストを送信してバックエンドサーバーの可用性を調査することで、ブラウザの動作をシミュレートします。 HTTPS：HTTPS ヘルスチェックは、HEAD または GET リクエストを送信してバックエンドサーバーの可用性を調査することで、ブラウザの動作をシミュレートします。HTTPS はデータ暗号化をサポートしているため、HTTP よりも高いセキュリティを提供します。 TCP：TCP ヘルスチェックは、TCP SYN パケットをバックエンドサーバーに送信して、バックエンドサーバーの可用性を調査します。 gRPC：gRPC ヘルスチェックは、POST または GET リクエストをバックエンドサーバーに送信して、バックエンドサーバーが正常かどうかを確認します。	HTTP
HealthCheckTimeout	integer	任意	ヘルスチェック応答のタイムアウト期間。バックエンドサーバーが指定されたタイムアウト期間内に応答しない場合、バックエンドサーバーは異常と宣言されます。単位：秒有効値：1～300 デフォルト値：5	5
HealthyThreshold	integer	任意	異常なバックエンドサーバーが正常と宣言されるまでに連続してヘルスチェックに合格する必要がある回数。この場合、バックエンドサーバーのヘルスチェックステータスは fail から success に変わります。有効値：2～10 デフォルト値：3。	3
UnhealthyThreshold	integer	任意	正常なバックエンドサーバーが異常と宣言されるまでに連続してヘルスチェックに失敗する必要がある回数。この場合、バックエンドサーバーのヘルスチェックステータスは success から fail に変わります。有効値：2～10 デフォルト値：3	3
StickySessionConfig	object	任意	セッション維持の設定。説明このパラメーターは、ServerGroupType パラメーターが Instance または Ip に設定されている場合に有効になります。
Cookie	string	任意	サーバー用に設定するクッキー。クッキーは 1～200 文字の長さで、ASCII 英字と数字のみを含めることができます。コンマ (,)、セミコロン (;)、またはスペース文字を含めることはできません。ドル記号 ($) で始めることはできません。説明このパラメーターは、StickySessionEnabled が true に設定され、かつ StickySessionType が server に設定されている場合にのみ有効です。	B490B5EBF6F3CD402E515D22BCDA****
CookieTimeout	integer	任意	セッションクッキーが期限切れになるまでの最大待機時間。単位：秒有効値：1～86400 デフォルト値：1000 説明このパラメーターは、StickySessionEnabled が true に設定され、かつ StickySessionType が Insert に設定されている場合にのみ有効です。	1000
StickySessionEnabled	boolean	任意	セッション維持を有効にするかどうかを指定します。有効値： true false 説明このパラメーターは、ServerGroupType パラメーターが Instance または Ip に設定されている場合に有効になります。	false
StickySessionType	string	任意	クッキーを処理するために使用されるメソッド。有効値： Insert (デフォルト値)：クッキーを挿入します。クライアントが初めて ALB にアクセスすると、ALB は HTTP または HTTPS レスポンスパケットに SERVERID クッキーを挿入します。このクッキーを持つクライアントからの後続のリクエストは、最初のリクエストと同じバックエンドサーバーに転送されます。 Server：クッキーを書き換えます。ALB はクライアントからのリクエストに含まれるカスタムクッキーを書き換えます。新しいクッキーを持つクライアントからの後続のリクエストは、最初のリクエストと同じバックエンドサーバーに転送されます。説明このパラメーターは、StickySessionEnabled パラメーターが true に設定されている場合に有効になります。	Insert
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは自動的にリクエスト ID をクライアントトークンとして使用します。リクエスト ID はリクエストごとに異なる場合があります。	5A2CFF0E-5718-45B5-9D4D-70B3FF3898
DryRun	boolean	任意	実際のリクエストを実行せずに、ドライランのみを実行するかどうかを指定します。有効値： true：ドライランのみを実行します。システムは、不足しているパラメーター値、不正なリクエスト構文、サービス制限など、リクエストの潜在的な問題を確認します。リクエストがドライランに失敗した場合、エラーコードが返されます。リクエストがドライランに合格した場合、`DryRunOperation` エラーコードが返されます。 false (デフォルト)：ドライランを実行し、実際のリクエストを実行します。リクエストがドライランに合格した場合、2xx HTTP ステータスコードが返され、操作が実行されます。	false
Ipv6Enabled	boolean	任意	IPv6 を有効にするかどうかを指定します。	false
UpstreamKeepaliveEnabled	boolean	任意	TCP 持続的接続を有効にするかどうかを指定します。	false
ServiceName	string	任意	このパラメーターは、ALB Ingress コントローラーが使用されている場合にのみ使用可能です。この場合、このパラメーターをサーバーグループに関連付けられている `Kubernetes Service` の名前に設定します。	test
UchConfig	object	任意	URL に基づく一貫性ハッシュの設定。
Type	string	必須	パラメーターのタイプ。	QueryString
Value	string	必須	一貫性ハッシュのパラメーター値。	abc
ConnectionDrainConfig	object	任意	接続ドレインの設定。接続ドレインを有効にすると、バックエンドサーバーが削除されたり、異常と判断された後も、ALB は一定期間データ転送を維持します。説明 Basic ALB インスタンスは接続ドレインをサポートしていません。Standard および WAF 対応 ALB インスタンスは接続ドレインをサポートしています。 Instance および IP タイプのサーバーグループは接続ドレインをサポートしています。Function Compute タイプのサーバーグループは接続ドレインをサポートしていません。
ConnectionDrainEnabled	boolean	任意	接続ドレインを有効にするかどうかを指定します。有効値： true false (デフォルト)	false
ConnectionDrainTimeout	integer	任意	接続ドレインのタイムアウト期間。有効値：0～900。デフォルト値：300。	300
SlowStartConfig	object	任意	スロースタートの設定。スロースタートを有効にすると、ALB は新しく追加されたバックエンドサーバーにデータをプリフェッチします。バックエンドサーバーに分散されるリクエストは徐々に増加します。説明 Basic ALB インスタンスはスロースタートをサポートしていません。Standard および WAF 対応 ALB インスタンスはスロースタートをサポートしています。 Instance および IP タイプのサーバーグループはスロースタートをサポートしています。Function Compute タイプのサーバーグループはスロースタートをサポートしていません。スロースタートは、重み付きラウンドロビンスケジューリングアルゴリズムでのみサポートされています。
SlowStartEnabled	boolean	任意	スロースタートを有効にするかどうかを指定します。有効値： true false (デフォルト)	false
SlowStartDuration	integer	任意	スロースタートの期間。有効値：30～900。デフォルト値：30。	30
Tag	array<object>	任意	タグ。
	object	任意
Key	string	任意	タグキー。タグキーは最大 128 文字で、`acs:` または `aliyun` で始めることはできません。`http://` または `https://` を含めることはできません。	env
Value	string	任意	タグ値。タグ値は最大 128 文字で、`acs:` または `aliyun` で始めることはできません。`http://` または `https://` を含めることはできません。	product
CrossZoneEnabled	boolean	任意	クロスゾーン負荷分散を有効にするかどうかを指定します。有効値： true (デフォルト) false 説明 Basic ALB インスタンスは、クロスゾーン負荷分散が無効になっているサーバーグループをサポートしていません。Standard および WAF 対応 ALB インスタンスのみが、クロスゾーン負荷分散が無効になっているサーバーグループをサポートしています。クロスゾーン負荷分散は、Instance および IP タイプのサーバーグループでは無効にできますが、Function Compute タイプのサーバーグループでは無効にできません。クロスゾーン負荷分散が無効になっている場合、セッション維持を有効にすることはできません。	true

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
JobId	string	非同期ジョブの ID。	72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestId	string	リクエスト ID。	365F4154-92F6-4AE4-92F8-7FF34B540710
ServerGroupId	string	サーバーグループの ID。	sg-atstuj3rtoptyui****

例

成功レスポンス

JSONJSON

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "ServerGroupId": "sg-atstuj3rtoptyui****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	QuotaExceeded.ServerGroupsNum	The quota of %s is exceeded, usage %s/%s.
400	Mismatch.LoadBalancerEditionAndSlowStartEnable	The %s and %s are mismatched.
400	Mismatch.ServerGroupSchedulerAndSlowStartEnable	The %s and %s are mismatched.
400	QuotaExceeded.SlowStartDuration	The quota of %s is exceeded, usage %s/%s.
400	UnsupportedFeature.SlowStart	The feature of %s is not supported.	The feature of %s is not supported.
400	Mismatch.LoadBalancerEditionAndConnectionDrain	The %s and %s are mismatched.
400	QuotaExceeded.ConnectionDrainTimeout	The quota of %s is exceeded, usage %s/%s.
400	UnsupportedFeature.ConnectionDrain	The feature of %s is not supported.
400	NotExist.ResourceGroup	ResourceGroup does not exist.
400	OperationDenied.VpcNotSupportIpv6	The operation is not allowed because of VpcNotSupportIpv6.
400	UnsupportedFeature.FcServerGroup	Server groups of type FC are not supported.
404	ResourceNotFound.Vpc	The specified resource %s is not found.

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

変更履歴

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