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 (デフォルト): クライアント IP アドレスの保持を有効にします。 false: クライアント IP アドレスの保持を無効にします。説明 Protocol が TCP にセットされ、このパラメーターが true にセットされている場合、サーバーグループは TCPSSL リスナーと関連付けることができません。	true
HealthCheckConfig	object	任意	ヘルスチェックの構成。
HealthCheckConnectPort	integer	任意	ヘルスチェックに使用されるバックエンドサーバーのポート。有効な値: 0～65535。デフォルト値: 0。この値は、バックエンドサーバーのポートがヘルスチェックに使用されることを示します。	0
HealthCheckConnectTimeout	integer	任意	ヘルスチェック応答の最大タイムアウト期間。単位: 秒。有効な値: 1～300。デフォルト値: 5。	5
HealthCheckDomain	string	任意	ヘルスチェックに使用されるドメイン名。有効な値: $SERVER_IP: バックエンドサーバーの内部 IP アドレス。 domain: 指定されたドメイン名。ドメイン名は 1～80 文字で、英字、数字、ハイフン (-)、ピリオド (.) のみを含めることができます。説明このパラメーターは、HealthCheckType が HTTP にセットされている場合にのみ効果があります。	$SERVER_IP
HealthCheckEnabled	boolean	任意	ヘルスチェックを有効にするかどうかを指定します。有効な値: true (デフォルト): ヘルスチェックを有効にします。 false: ヘルスチェックを無効にします。	true
HealthCheckExp	string	任意	UDP リスナーのヘルスチェックリクエスト内のクエリ文字列。文字列には英字と数字のみを含めることができ、最大 512 文字です。	ok
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
HealthCheckHttpVersion	string	任意	ヘルスチェックの HTTP プロトコルバージョン。有効な値: HTTP1.0 (デフォルト) および HTTP1.1。説明このパラメーターは、HealthCheckType が HTTP にセットされている場合にのみ効果があります。	HTTP1.0
HealthCheckInterval	integer	任意	2 回の連続するヘルスチェックの間隔。単位: 秒。デフォルト値: 5。 HealthCheckType が TCP または HTTP に設定されている場合、有効な値は 1～50 です。 HealthCheckType が UDP に設定されている場合、有効な値は 1～300 です。UDP プローブ応答がタイムアウトにより応答なしと誤判定されないように、間隔を応答タイムアウト期間以上に設定する必要があります。	5
HealthCheckReq	string	任意	UDP リスナーのヘルスチェックリクエスト内のクエリ文字列。文字列には英字と数字のみを含めることができ、最大 512 文字です。	hello
HealthCheckType	string	任意	ヘルスチェックに使用されるプロトコル。有効な値: TCP HTTP UDP	TCP
HealthCheckUrl	string	任意	ヘルスチェックのパス。パスは 1～80 文字で、英字、数字、および次の特殊文字のみを含めることができます: `-/.%?#&`。スラッシュ (/) で始める必要があります。説明このパラメーターは、HealthCheckType が HTTP にセットされている場合にのみ効果があります。	/test/index.html
HealthyThreshold	integer	任意	バックエンドサーバーのヘルスチェックステータスが fail から success に変更されるまでに必要な、連続して成功したヘルスチェックの回数。有効な値: 2～10。デフォルト値: 2。	2
HttpCheckMethod	string	任意	ヘルスチェックに使用される HTTP メソッド。有効な値: GET (デフォルト) および HEAD。説明このパラメーターは、HealthCheckType が HTTP にセットされている場合にのみ効果があります。	GET
UnhealthyThreshold	integer	任意	バックエンドサーバーのヘルスチェックステータスが success から fail に変更されるまでに必要な、連続して失敗したヘルスチェックの回数。有効な値: 2～10。デフォルト値: 2。	2
ResourceGroupId	string	任意	サーバーグループが属するリソースグループの ID。	rg-atstuj3rtop****
DryRun	boolean	任意	リクエストの事前チェックのみを実行するかどうかを指定します。有効な値: true: サーバーグループを作成せずにリクエストを事前チェックします。システムは、必須パラメーターが指定されているか、リクエストフォーマット、およびサービスの制限を確認します。リクエストが事前チェックに失敗した場合、対応するエラーが返されます。リクエストが事前チェックに合格した場合、`DryRunOperation` エラーコードが返されます。 false (デフォルト): リクエストを送信します。リクエストが事前チェックに合格した場合、HTTP 2xx 状態コードが返され、操作が実行されます。	true
ClientToken	string	任意	リクエスト呼び出しのべき等性を確保するために使用されるクライアントトークン。クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。クライアントトークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは API リクエストの RequestId を ClientToken として自動的に使用します。各 API リクエストの RequestId は一意です。	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://` を含めることはできません。英字、数字、アンダースコア (_)、ピリオド (.)、コロン (:)、スラッシュ (/)、等号 (=)、プラス記号 (+)、ハイフン (-)、およびアットマーク (@) を含めることができます。 1 回の呼び出しで最大 20 個のタグを追加できます。	env
Value	string	任意	タグ値。タグ値は最大 128 文字で、`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることはできません。英字、数字、アンダースコア (_)、ピリオド (.)、コロン (:)、スラッシュ (/)、等号 (=)、プラス記号 (+)、ハイフン (-)、およびアットマーク (@) を含めることができます。 1 回の呼び出しで最大 20 個のタグを追加できます。	product

レスポンスフィールド

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

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	IllegalParam.AnyPortServerGroupConflictWithHealthCheckConfig	The param of AnyPortServerGroupConflictWithHealthCheckConfig is illegal.	サーバーグループの構成がヘルスチェック設定と競合しています。構成パラメーターを確認してください。
400	IllegalParamFormat.ParseCreateRsPoolRequestFailed	The param format of CreateRsPoolRequest is illegal.	CreateRsPoolRequestFailed のパラメーターフォーマットが無効です。API リファレンスを参照して、リクエストパラメーターを確認してください。
400	IllegalParam.PreserveClientIpSwitch	The param of PreserveClientIpSwitch is illegal.
400	OperationDenied.VpcNotSupportIpv6	The operation is not allowed because of VpcNotSupportIpv6.	指定された VPC は IPv6 をサポートしていません。
400	IllegalParam.healthCheckDomain	The parameter of healthCheckConfig.healthCheckDomain is illegal.	ヘルスチェック構成の healthCheckDomain が無効です。入力パラメーターを確認してください。
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.	ヘルスチェック設定で使用されているヘルスチェック URL が無効です。
400	IllegalParam.ServerGroupName	The param of ServerGroupName is illegal.	ServerGroupName パラメーターが無効です。
400	DryRunOperation	Request validation has been passed with DryRun flag set.	ドライランリクエストの検証に成功しました。
400	MissingParam.%s	The parameter of %s is missing.	パラメーター %s が指定されていません。入力パラメーターを確認してください。
400	IllegalParam.ConnectionDrainTimeout	The param of ConnectionDrainTimeout is illegal.	ConnectionDrainTimeout パラメーターが無効です。入力パラメーターを確認してください。
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.	クォータが不足しています。使用量: %s/%s。クォータセンターでクォータを変更してください。
403	Forbidden.NoPermission	Authentication is failed for NoPermission.	アカウントに必須の権限がないため、認証に失敗しました。
404	ResourceNotFound.Vpc	The specified resource of Vpc is not found.	指定された VPC リソースが見つかりません。入力パラメーターを確認してください。
404	ResourceNotFound.ResourceGroup	The param of resourceGroup not existed.	リソースグループが存在しません。

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

変更履歴

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