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

指定されたリージョンにサーバーグループを作成します。

操作説明

CreateServerGroup は非同期操作です。リクエストを送信すると、システムはリクエスト ID を返します。Network Load Balancer (NLB) インスタンスのサーバーグループはバックグラウンドで作成されます。GetJobStatus 操作を呼び出して、サーバーグループの作成ステータスをクエリできます。

タスクステータスが Succeeded の場合、サーバーグループは作成済みです。
タスクステータスが Processing の場合、サーバーグループは作成中です。この状態では、クエリ操作のみ実行できます。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

nlb:CreateServerGroup

create

*ServerGroup

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

*VPC

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ServerGroupType	string	任意	サーバーグループのタイプ。有効値： Instance (デフォルト)：インスタンスタイプのサーバーグループ。このタイプのサーバーグループでは、Elastic Compute Service (ECS) インスタンス、伸縮性ネットワークインターフェース (ENI)、および伸縮性コンテナインスタンス (ECI) を追加できます。 Ip：IP アドレスタイプのサーバーグループ。このタイプのサーバーグループでは、IP アドレスを指定してバックエンドサーバーを追加できます。	Instance
ServerGroupName	string	必須	サーバーグループの名前。名前は長さが 2～128 文字で、先頭は英字である必要があります。数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。	NLB_ServerGroup
AddressIPVersion	string	任意	IP バージョン。有効値： ipv4 (デフォルト)：IPv4。 DualStack：デュアルスタック。	ipv4
Protocol	string	任意	デュアルスタックモードのトラフィックスケジューリングポリシー。有効値： NonAffinity (デフォルト)：リクエストは、送信元 IP バージョンに関係なく、スケジューリングアルゴリズムに基づいて正常なバックエンドサーバーに転送されます。 Affinity：リクエストは送信元 IP バージョンに基づいて転送されます。IPv4 リクエストは IPv4 バックエンドサーバーにのみ転送されます。IPv6 リクエストは IPv6 バックエンドサーバーにのみ転送されます。説明このパラメーターは、AddressIPVersion が DualStack に設定されている場合にのみ適用されます。	TCP
VpcId	string	必須	バックエンドサーバーにリクエストを転送するためのプロトコル。有効値： TCP (デフォルト) UDP TCP_UDP 説明このパラメーターを UDP に設定した場合、サーバーグループは UDP リスナーのみをサポートします。このパラメーターを TCP に設定し、PreserveClientIpEnabled を true に設定した場合、サーバーグループは TCP リスナーのみをサポートします。このパラメーターを TCP に設定し、PreserveClientIpEnabled を false に設定した場合、サーバーグループは TCPSSL リスナーと TCP リスナーの両方をサポートします。このパラメーターを TCP_UDP に設定した場合、サーバーグループは TCP リスナーと UDP リスナーの両方をサポートします。	vpc-bp15zckdt37pq72zv****
AnyPortEnabled	boolean	任意	サーバーグループが配置されている VPC の ID。説明 ServerGroupType が Instance に設定されている場合、この VPC 内のサーバーのみをサーバーグループに追加できます。	false
ConnectionDrainEnabled	boolean	任意	全ポート転送を有効にするかどうかを指定します。有効値： true false (デフォルト)	false
ConnectionDrainTimeout	integer	任意	接続ドレインを有効にするかどうかを指定します。有効値： true：有効化。 false (デフォルト)：無効化。	10
Scheduler	string	任意	接続ドレインのタイムアウト時間 (秒単位)。有効値は 0～900 です。	Wrr
PreserveClientIpEnabled	boolean	任意	スケジューリングアルゴリズム。有効値： Wrr (デフォルト)：重み付きラウンドロビン。重みが大きいバックエンドサーバーほど多くのリクエストを受け取ります。 Wlc：重み付き最小接続。このアルゴリズムは、各バックエンドサーバーの重みとアクティブな接続数の両方を考慮します。サーバーの重みが同じ場合、接続数が最も少ないサーバーが次のリクエストを受け取ります。 rr：ラウンドロビン。リクエストはバックエンドサーバーに順番に分散されます。 sch：送信元 IP ハッシュ。同じ送信元 IP アドレスからのリクエストは、同じバックエンドサーバーにルーティングされます。 tch：4 タプルハッシュ。これは 4 タプル (送信元 IP アドレス、宛先 IP アドレス、送信元ポート、宛先ポート) に基づくコンシステントハッシュです。同じストリーム内のリクエストは、同じバックエンドサーバーにルーティングされます。 qch：QUIC ID ハッシュ。同じ QUIC ID を持つリクエストは、同じバックエンドサーバーにハッシュされます。説明 QUIC ID ハッシュは、バックエンドプロトコルが UDP の場合にのみサポートされます。	true
HealthCheckConfig	object	任意	クライアント IP の永続化を有効にするかどうかを指定します。有効値： true (デフォルト)：有効。 false：無効。説明 Protocol が TCP に設定され、このパラメーターが true に設定されている場合、サーバーグループは TCPSSL リスナーに関連付けることはできません。
HealthCheckEnabled	boolean	任意	ヘルスチェックを有効にするかどうかを指定します。有効値： true (デフォルト) false	true
HealthCheckType	string	任意	ヘルスチェックプロトコル。有効値： TCP HTTP UDP	TCP
HealthCheckConnectPort	integer	任意	バックエンドサーバーのヘルスチェックに使用されるポート。有効値：0～65535。デフォルト値：0。値が 0 の場合、バックエンドサーバーのポートがヘルスチェックに使用されることを意味します。	0
HealthyThreshold	integer	任意	バックエンドサーバーのヘルスチェックステータスを「失敗」から「成功」に変更するために必要な、連続したヘルスチェックの成功回数。有効値：2～10。デフォルト値：2。	2
UnhealthyThreshold	integer	任意	バックエンドサーバーのヘルスチェックステータスを「成功」から「失敗」に変更するために必要な、連続したヘルスチェックの失敗回数。有効値：2～10。デフォルト値：2。	2
HealthCheckConnectTimeout	integer	任意	ヘルスチェック応答の最大タイムアウト時間。単位：秒。有効値：1～300。デフォルト値：5。	5
HealthCheckInterval	integer	任意	2 回の連続したヘルスチェックの間隔。単位：秒。デフォルト値：5。 HealthCheckType が TCP または HTTP に設定されている場合、値は 1～50 の範囲である必要があります。 HealthCheckType が UDP に設定されている場合、値は 1～300 の範囲である必要があります。UDP プローブがタイムアウトとしてマークされるのを防ぐため、間隔を応答タイムアウト時間以上の値に設定してください。	5
HealthCheckDomain	string	任意	ヘルスチェックに使用されるドメイン名。有効値： $SERVER_IP：バックエンドサーバーのプライベート IP アドレス。 domain：特定のドメイン名。ドメイン名は 1～80 文字で、英字、数字、ハイフン (-)、ピリオド (.) を使用できます。このパラメーターは、HealthCheckType が HTTP に設定されている場合にのみ有効です。	$SERVER_IP
HealthCheckUrl	string	任意	ヘルスチェックに使用されるパス。パスは 1～80 文字である必要があります。英字、数字、および次の特殊文字を含めることができます：-/.%?#&。パスはスラッシュ (/) で始まる必要があります。このパラメーターは、HealthCheckType が HTTP に設定されている場合にのみ有効です。	/test/index.html
HealthCheckHttpCode	array	任意	バックエンドサーバーが正常であることを示す HTTP ステータスコード。複数の HTTP ステータスコードはコンマ (,) で区切ります。有効値：http_2xx (デフォルト)、http_3xx、http_4xx、http_5xx。このパラメーターは、HealthCheckType が HTTP に設定されている場合にのみ有効です。
	string	任意	バックエンドサーバーが正常であることを示す HTTP ステータスコード。複数の HTTP ステータスコードはコンマ (,) で区切ります。有効値：http_2xx (デフォルト)、http_3xx、http_4xx、http_5xx。このパラメーターは、HealthCheckType が HTTP に設定されている場合にのみ有効です。	http_2xx
HttpCheckMethod	string	任意	ヘルスチェックに使用される HTTP メソッド。有効値：GET (デフォルト) および HEAD。このパラメーターは、HealthCheckType が HTTP に設定されている場合にのみ有効です。	GET
HealthCheckReq	string	任意	UDP ヘルスチェックのリクエスト文字列。文字列には英字と数字のみを含めることができます。最大長は 512 文字です。	hello
HealthCheckExp	string	任意	UDP ヘルスチェックで期待される応答文字列。文字列は英数字である必要があり、最大長は 512 文字です。	ok
HealthCheckHttpVersion	string	任意	HTTP プロトコルのバージョン。有効値：HTTP1.0 (デフォルト) および HTTP1.1。このパラメーターは、HealthCheckType が HTTP に設定されている場合にのみ有効です。	HTTP1.0
ResourceGroupId	string	任意	ヘルスチェックの設定。	rg-atstuj3rtop****
DryRun	boolean	任意	サーバーグループが属するリソースグループの ID。	true
ClientToken	string	任意	ドライランを実行するかどうかを指定します。有効値： true：サーバーグループを作成せずにチェックリクエストを送信します。システムは必須パラメーター、リクエスト形式、およびサービス制限をチェックします。リクエストがチェックに失敗した場合、システムはエラーを返します。リクエストがチェックに合格した場合、システムは `DryRunOperation` エラーコードを返します。 false (デフォルト)：通常のリクエストを送信します。リクエストがチェックに合格した場合、システムは HTTP 2xx ステータスコードを返し、サーバーグループを作成します。	123e4567-e89b-12d3-a456-426655440000
RegionId	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアント側で値を生成します。各リクエストで値が一意であることを確認してください。ClientToken パラメーターは ASCII 文字のみをサポートします。説明このパラメーターを指定しない場合、システムは API リクエストの RequestId を ClientToken として使用します。RequestId は API リクエストごとに一意です。	cn-hangzhou
Tag	array<object>	任意	Network Load Balancer (NLB) インスタンスがデプロイされているリージョンの ID。 DescribeRegions 操作を呼び出してリージョン ID を取得します。
	object	任意	タグ。
Key	string	任意	タグキー。キーは最大 64 文字です。aliyun または acs: で始めることはできません。http:// または https:// を含めることはできません。英字、数字、アンダースコア (_)、ピリオド (.)、コロン (:)、スラッシュ (/)、等号 (=)、プラス記号 (+)、ハイフン (-)、アットマーク (@) を含めることができます。1 回の呼び出しで最大 20 個のタグを追加します。	env
Value	string	任意	タグの値。値は最大 128 文字です。`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることはできません。英字、数字、アンダースコア (_)、ピリオド (.)、コロン (:)、スラッシュ (/)、等号 (=)、プラス記号 (+)、ハイフン (-)、アットマーク (@) を含めることができます。 1 回の呼び出しで最大 20 個のタグを含めることができます。	product
IpVersionAffinityMode	string	任意	タグ。	Affinity

レスポンスフィールド

フィールド	型	説明	例
	object	サーバーグループが作成されました。
RequestId	string	リクエスト ID。	54B48E3D-DF70-471B-AA93-08E683A1B45
ServerGroupId	string	サーバーグループ ID。	sgp-atstuj3rtoptyui****
JobId	string	非同期タスクの ID。	72dcd26b-f12d-4c27-b3af-18f6aed5****

例

成功レスポンス

JSONJSON

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "ServerGroupId": "sgp-atstuj3rtoptyui****",
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	IllegalParam.AnyPortServerGroupConflictWithHealthCheckConfig	The param of AnyPortServerGroupConflictWithHealthCheckConfig is illegal.
400	IllegalParamFormat.ParseCreateRsPoolRequestFailed	The param format of CreateRsPoolRequest is illegal.
400	IllegalParam.PreserveClientIpSwitch	The param of PreserveClientIpSwitch is illegal.
400	OperationDenied.VpcNotSupportIpv6	The operation is not allowed because of VpcNotSupportIpv6.
400	IllegalParam.healthCheckDomain	The parameter of healthCheckConfig.healthCheckDomain is illegal.
400	OperationDenied.UidNotAllowQuic29	The operation is not allowed because of uid not allow quic29 version.
400	IlleagalParam.healthCheckUrl	The parameter of healthCheckUrl in healthCheckConfig is illegal.
400	IllegalParam.ServerGroupName	The param of ServerGroupName is illegal.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	日文说明6
400	MissingParam.%s	The parameter of %s is missing.
400	IllegalParam.ConnectionDrainTimeout	The param of ConnectionDrainTimeout is illegal.
400	IllegalParam	The param of %s is illegal.
400	SystemBusy	System is busy, please try again later.
400	QuotaExceeded.QuotaInsufficient	The quota of %s is exceeded, usage %s/%s.
403	Forbidden.NoPermission	Authentication is failed for NoPermission.
404	ResourceNotFound.Vpc	The specified resource of Vpc is not found.
404	ResourceNotFound.ResourceGroup	The param of resourceGroup not existed.

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

変更履歴

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