CreateServerGroup API を呼び出してサーバーグループを作成する - Server Load Balancer - Alibaba Cloud - Server Load Balancer

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

操作説明

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 (デフォルト): サーバータイプ。このタイプのサーバーグループでは、Ecs、Eni、Eci タイプのインスタンスを追加できます。 Ip: IP アドレスタイプ。このタイプのサーバーグループでは、IP アドレスでバックエンドサーバーを直接追加できます。	Instance
ServerGroupName	string	必須	サーバーグループの名前。名前は 2～128 文字で、大文字、小文字、または漢字で始まる必要があります。数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができます。	NLB_ServerGroup
AddressIPVersion	string	任意	プロトコルのバージョン。有効な値: ipv4 (デフォルト): IPv4。 DualStack: デュアルスタック。	ipv4
IpVersionAffinityMode	string	任意	デュアルスタックモードにおけるトラフィックスケジューリングポリシー: NonAffinity (デフォルト): 非アフィニティモード。ソースの IP プロトコルバージョンに関係なく、スケジューリングアルゴリズムに基づいて正常なバックエンドサーバーにトラフィックが転送されます。 Affinity: アフィニティモード。リクエストソースの IP プロトコルバージョンに基づいてトラフィックが転送されます。IPv4 リクエストは IPv4 バックエンドサーバーにのみ転送され、IPv6 リクエストは IPv6 バックエンドサーバーにのみ転送されます。説明このパラメーターは、AddressIPVersion が DualStack にセットされている場合にのみ効果が有効です。	Affinity
Protocol	string	任意	バックエンドサーバーへのリクエスト転送に使用される通信プロトコル。有効な値: TCP (デフォルト) UDP TCP_UDP 説明このパラメーターが UDP にセットされている場合、サーバーグループは UDP リスナーとのみ関連付けることができます。このパラメーターが TCP にセットされ、PreserveClientIpEnabled が true にセットされている場合、サーバーグループは TCP リスナーとのみ関連付けることができます。このパラメーターが TCP にセットされ、PreserveClientIpEnabled が false にセットされている場合、サーバーグループは TCPSSL リスナーおよび TCP リスナーと関連付けることができます。このパラメーターが TCP_UDP にセットされている場合、サーバーグループは TCP リスナーおよび UDP リスナーと関連付けることができます。	TCP
VpcId	string	必須	サーバーグループが属する仮想非公開クラウド (VPC) の ID。説明 ServerGroupType が Instance にセットされている場合、この VPC 内のサーバーのみをサーバーグループに追加できます。	vpc-bp15zckdt37pq72zv****
AnyPortEnabled	boolean	任意	全ポートフォワーディングを有効にするかどうかを指定します。有効な値: true: 有効。 false (デフォルト): 無効。	false
ConnectionDrainEnabled	boolean	任意	接続ドレインを有効にするかどうかを指定します。有効な値: true: 有効。 false (デフォルト): 無効。	false
ConnectionDrainTimeout	integer	任意	接続ドレインのタイムアウト期間。単位: 秒。有効な値: 0 ～ 900。	10
Scheduler	string	任意	スケジューリングアルゴリズム。有効な値: Wrr (デフォルト): 重み付きラウンドロビン。重みの大きいバックエンドサーバーほど頻繁にポーリングされます。 Wlc: 重み付き最小接続数。各バックエンドサーバーの重みに加え、実際のロード (接続数) も考慮されます。重みが同じ場合、現在の接続数が少ないバックエンドサーバーほど頻繁にポーリングされます。 rr: ラウンドロビン。リクエストはシーケンスに従ってバックエンドサーバーに分散されます。 sch: ソース IP ハッシュ化。同じソース IP アドレスからのリクエストは、同じバックエンドサーバーに分散されます。 tch: 4 要素ハッシュ化。4 つの要素 (ソース IP アドレス、宛先 IP アドレス、送信元ポート、宛先ポート) に基づく一貫したハッシュ。同じストリームは同じバックエンドサーバーに分散されます。 qch: QUIC ID ハッシュ化。同じ QUIC ID を持つリクエストは、同じバックエンドサーバーに分散されます。説明 QUIC ID ハッシュ化は、バックエンドプロトコルが UDP の場合にのみサポートされます。	Wrr
PreserveClientIpEnabled	boolean	任意	クライアント IP の保持を有効にするかどうかを指定します。有効な値: true (デフォルト): 有効。 false: 無効。説明 Protocol が TCP にセットされ、このパラメーターが true にセットされている場合、サーバーグループは TCPSSL リスナーと関連付けることができません。	true
HealthCheckConfig	object	任意	ヘルスチェックの構成。
HealthCheckEnabled	boolean	任意	ヘルスチェックを有効にするかどうかを指定します。有効な値: true (デフォルト): 有効。 false: 無効。	true
HealthCheckType	string	任意	ヘルスチェックに使用されるプロトコル。有効な値: TCP HTTP UDP	TCP
HealthCheckConnectPort	integer	任意	ヘルスチェックに使用されるバックエンドサーバーのポート。有効な値: 0 ～ 65535。デフォルト値: 0。これは、バックエンドサーバーのポートがヘルスチェックに使用されることを示します。	0
HealthyThreshold	integer	任意	バックエンドサーバーが正常であると宣言される (ステータスが fail から success に変わる) までに必要な連続したヘルスチェック成功回数。有効な値: 2 ～ 10。デフォルト値: 2。	2
UnhealthyThreshold	integer	任意	バックエンドサーバーが異常であると宣言される (ステータスが success から fail に変わる) までに必要な連続した失敗したヘルスチェック回数。有効な値: 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_2xx (デフォルト)、http_3xx、http_4xx、http_5xx。説明このパラメーターは、HealthCheckType が HTTP にセットされている場合にのみ効果が有効です。
	string	任意	正常なバックエンドサーバーに対して返される HTTP 状態コード。複数の状態コードはカンマ (,) で区切ります。有効な値: http_2xx (デフォルト)、http_3xx、http_4xx、http_5xx。説明このパラメーターは、HealthCheckType が HTTP にセットされている場合にのみ効果が有効です。	http_2xx
HttpCheckMethod	string	任意	ヘルスチェックメソッド。有効な値: 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	任意	サーバーグループが属するリソースグループの ID。	rg-atstuj3rtop****
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効な値: true: サーバーグループを作成せずにドライランを実行します。システムは必須パラメーター、リクエストフォーマット、サービス制限をチェックします。チェックが失敗した場合、対応するエラーが返されます。チェックが成功した場合、エラーコード `DryRunOperation` が返されます。 false (デフォルト): リクエストを送信します。リクエストがチェックを通過した後、HTTP 2xx 状態コードが返され、操作が実行されます。	true
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。クライアントトークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは API リクエストの RequestId を ClientToken として使用します。RequestId は API リクエストごとに異なる場合があります。	123e4567-e89b-12d3-a456-426655440000
RegionId	string	任意	Network Load Balancer (NLB) インスタンスのリージョン ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
Tag	array<object>	任意	タグリスト。
	object	任意	タグ。
Key	string	任意	タグキー。タグキーの長さは最大 64 文字で、`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることはできません。有効な文字には、英数字、アンダースコア (_)、ピリオド (.)、コロン (:)、スラッシュ (/)、等号 (=)、プラス記号 (+)、ハイフン (-)、アットマーク (@) が含まれます。呼び出しごとに最大 20 個のタグを追加できます。	env
Value	string	任意	タグ値。タグ値の長さは最大 128 文字で、`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることはできません。有効な文字には、英数字、アンダースコア (_)、ピリオド (.)、コロン (:)、スラッシュ (/)、等号 (=)、プラス記号 (+)、ハイフン (-)、アットマーク (@) が含まれます。呼び出しごとに最大 20 個のタグを追加できます。	product

レスポンスフィールド

フィールド	型	説明	例
	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.

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

変更履歴

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