API による ALB サーバーグループの構築と監視 - ALB - Alibaba Cloud - Server Load Balancer

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

操作説明

CreateServerGroup API オペレーションは非同期です。この操作を呼び出すと、システムはリクエスト ID を返しますが、サーバーグループはまだ作成されておらず、作成タスクは背景で実行中です。 ListServerGroups 操作を呼び出して、サーバーグループの作成ステータスをクエリできます。

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

alb:CreateServerGroup

create

*ServerGroup。

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

alb:ServerGroupProtocol

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ServerGroupName	string	必須	サーバーグループの名前。名前は 2～128 文字で、英字、漢字、または数字で始める必要があります。数字、期間 (.)、アンダースコア (_)、ハイフン (-)、およびスペースを含めることができます。	test
ServerGroupType	string	任意	サーバーグループのタイプ。有効な値: Instance (デフォルト): サーバータイプ。このタイプのサーバーグループでは、Ecs、Eni、および Eci インスタンスの追加がサポートされています。 Ip: IP アドレスタイプ。このタイプのサーバーグループでは、IP アドレスによるバックエンドサーバーの追加がサポートされています。 Fc: Function Compute タイプ。このタイプのサーバーグループでは、Function Compute バックエンドサーバーの追加がサポートされています。	Instance
VpcId	string	任意	VPC に接続されたインスタンスの ID。この VPC 内のサーバーのみをサーバーグループに追加できます。説明このパラメーターは、ServerGroupType が Instance または Ip にセットされている場合にのみ効果を発揮します。	vpc-bp15zdkdt37pq72zv****
Scheduler	string	任意	スケジューリングアルゴリズム。有効な値: Wrr (デフォルト): 重み付き四捨五入ロビン。重みが大きいバックエンドサーバーほどポーリングされる可能性が高くなります。 Wlc: 重み付き最小接続数。各バックエンドサーバーの重みに基づいてポーリングするだけでなく、バックエンドサーバーの実際のロード (接続数) も考慮します。重みが同じ場合、現在の接続数が少ないバックエンドサーバーほどポーリングされる可能性が高くなります。 Sch: 一貫したハッシュ化。ハッシュ係数の計算結果が同じリクエストは、同じバックエンドサーバーにスケジューリングされます。UchConfig パラメーターが設定されていない場合、デフォルトのハッシュ係数はソース IP アドレスであり、同じソース IP アドレスからのリクエストは同じバックエンドサーバーに分散されます。UchConfig パラメーターが設定されている場合、ハッシュ係数は URL パラメーターであり、同じ URL パラメーターを持つリクエストは同じバックエンドサーバーに分散されます。説明このパラメーターは、ServerGroupType が Instance または Ip にセットされている場合にのみ効果を発揮します。	Wrr
Protocol	string	任意	バックエンドプロトコル。有効な値: HTTP (デフォルト): HTTPS、HTTP、および QUIC リストナーとの関連付けをサポートします。 HTTPS: HTTP および HTTPS リストナーとの関連付けをサポートします。 gRPC: HTTPS リストナーと関連付けます。説明 ServerGroupType が Fc にセットされている場合、バックエンドプロトコルを設定する必要はありません。	HTTP
ResourceGroupId	string	任意	リソースグループの ID。	rg-atstuj3rsop****
HealthCheckConfig	object	必須	ヘルスチェック構成。	rg-123
HealthCheckConnectPort	integer	任意	ヘルスチェックに使用されるバックエンドサーバーのポート。有効な値: 0～65535。デフォルト値: 0。バックエンドサーバーのポートがヘルスチェックに使用されることを示します。	80
HealthCheckEnabled	boolean	必須	ヘルスチェックを有効にするかどうかを指定します。有効な値: true: ヘルスチェックを有効にします。 false: ヘルスチェックを無効にします。説明デフォルトでは、ServerGroupType が Instance または Ip に設定されている場合はヘルスチェックが有効になり、Fc に設定されている場合は無効になります。	true
HealthCheckHost	string	任意	ヘルスチェックに使用されるドメイン名。有効な値: Internal IP address of the backend server (デフォルト): バックエンドサーバーの内部 IP アドレスをヘルスチェックのドメイン名として使用します。 Custom domain name: ドメイン名を指定します。ドメイン名は 1～80 文字である必要があります。小文字、数字、ハイフン (-)、および期間 (.) を含めることができます。少なくとも 1 つの期間 (.) を含める必要があり、期間 (.) を先頭または末尾に配置することはできません。最も右側のドメインラベルには文字のみを含めることができ、数字やハイフン (-) を含めることはできません。ハイフン (-) を先頭または末尾に配置することはできません。説明このパラメーターは、HealthCheckProtocol が HTTP、HTTPS、または gRPC にセットされている場合にのみ効果を発揮します。	www.example.com
HealthCheckCodes	array	任意	ヘルスチェックの成功を示す状態コードのリスト。
	string	任意	ヘルスチェックの成功を示す状態コード。 HealthCheckProtocol が HTTP または HTTPS にセットされている場合、HealthCheckCodes の有効な値は http_2xx (デフォルト)、http_3xx、http_4xx、および http_5xx です。複数の状態コードはコンマ (,) で区切ります。 HealthCheckProtocol が gRPC にセットされている場合、HealthCheckCodes の有効値は 0～99 で、デフォルト値は 0 です。範囲を指定でき、最大 20 個の範囲がサポートされています。複数の範囲はコンマ (,) で区切ります。説明このパラメーターは、HealthCheckProtocol が HTTP、HTTPS、または gRPC にセットされている場合にのみ効果を発揮します。	http_2xx
HealthCheckHttpVersion	string	任意	ヘルスチェックに使用される HTTP バージョン。有効な値: HTTP1.0 および HTTP1.1 (デフォルト)。説明このパラメーターは、HealthCheckProtocol が HTTP または HTTPS にセットされている場合にのみ効果を発揮します。	HTTP1.1
HealthCheckInterval	integer	任意	2 回の連続するヘルスチェック間の間隔。単位: 秒。有効な値: 1～50。デフォルト値: 2。	2
HealthCheckMethod	string	任意	ヘルスチェックに使用される HTTP メソッド。有効な値: GET: 応答メッセージの長さが 8 KB を超える場合、切り詰められますが、ヘルスチェックの結果には影響しません。 POST: gRPC リストナーのヘルスチェックのデフォルトメソッド。 HEAD (デフォルト): HTTP および HTTPS リストナーのヘルスチェックのデフォルトメソッド。説明このパラメーターは、HealthCheckProtocol が HTTP、HTTPS、または gRPC にセットされている場合にのみ効果を発揮します。	HEAD
HealthCheckPath	string	任意	ヘルスチェックに使用されるパス。パスは 1～80 文字で、文字、数字、および次の特殊文字 `-/.%?#&=` と拡張文字 `_;~!()[]@$^:',+` のみを含めることができます。パスは転送スラッシュ (/) で始める必要があります。説明このパラメーターは、HealthCheckProtocol* が HTTP または HTTPS にセットされている場合にのみ効果を発揮します。	/test/index.html
HealthCheckProtocol	string	任意	ヘルスチェックに使用されるプロトコル。有効な値: HTTP: HEAD または GET リクエストを送信してブラウザアクセスの偽装を実行し、サーバーアプリケーションが正常かどうかを確認します。 HTTPS: HEAD または GET リクエストを送信してブラウザアクセスの偽装を実行し、サーバーアプリケーションが正常かどうかを確認します (データ暗号化により、HTTP よりも安全です)。 TCP: SYN ハンドシェイクメッセージを送信して、サーバーポートが応答可能かどうかを確認します。 gRPC: POST または GET リクエストを送信して、サーバーアプリケーションが正常かどうかを確認します。	HTTP
HealthCheckTimeout	integer	任意	ヘルスチェック応答のタイムアウト期間。バックエンドサーバーが指定されたタイムアウト期間内に応答しない場合、ヘルスチェックは失敗します。単位: 秒。有効な値: 1～300。デフォルト値: 5。	5
HealthyThreshold	integer	任意	バックエンドサーバーのヘルスチェックステータスを Failed から Successful に変更するために必須の、連続したヘルスチェック成功回数。有効な値: 2～10。デフォルト値: 3。	3
UnhealthyThreshold	integer	任意	バックエンドサーバーのヘルスチェックステータスを Successful から Failed に変更するために必須の、連続した失敗したヘルスチェックの回数。有効な値: 2～10。デフォルト値: 3。	3
StickySessionConfig	object	任意	セッション維持構成。説明このパラメーターは、ServerGroupType が Instance または Ip にセットされている場合にのみ効果を発揮します。
Cookie	string	任意	サーバーで設定された Cookie。 Cookie は 1～200 文字で、ASCII 文字と数字のみを含めることができます。コンマ (,)、セミコロン (;)、またはスペースを含めることはできず、ドル署名 ($) で始めることはできません。説明このパラメーターは、StickySessionEnabled が true にセットされ、StickySessionType が server にセットされている場合にのみ効果を発揮します。	B490B6EBF6F3CD402E515D22BCDA****
CookieTimeout	integer	任意	Cookie のタイムアウト期間。単位: 秒。有効な値: 1～86400。デフォルト値: 1000。説明このパラメーターは、StickySessionEnabled が true にセットされ、StickySessionType が Insert にセットされている場合にのみ効果を発揮します。	1000
StickySessionEnabled	boolean	任意	セッション維持を有効にするかどうかを指定します。有効な値: true: セッション維持を有効にします。 false: セッション維持を無効にします。説明このパラメーターは、ServerGroupType が Instance または Ip にセットされている場合にのみ効果を発揮します。	false
StickySessionType	string	任意	Cookie をハンドルするために使用されるメソッド。有効な値: Insert (デフォルト): Cookie を挿入します。クライアントが初めてサーバーにアクセスするとき、負荷分散は Cookie を挿入します (つまり、HTTP または HTTPS 応答メッセージに SERVERID を挿入します)。次の時間クライアントがこの Cookie を使用してサーバーにアクセスするとき、負荷分散は以前に記録されたバックエンドサーバーにリクエストを転送します。 Server: Cookie を書き換えます。負荷分散がユーザー定義の Cookie を検出すると、元の Cookie を書き換えます。次の時間クライアントが新しい Cookie を使用してサーバーにアクセスするとき、負荷分散は以前に記録されたバックエンドサーバーにリクエストを転送します。説明このパラメーターは、StickySessionEnabled が true にセットされている場合にのみ効果を発揮します。	Insert
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。クライアントトークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは API リクエスト呼び出しの RequestId を ClientToken として自動的に使用します。各 API リクエスト呼び出しの RequestId は異なる場合があります。	5A2CAF0E-5718-45B5-9D4D-70B******
DryRun	boolean	任意	リクエストの事前チェックのみを実行するかどうかを指定します。有効な値: true: サーバーグループを作成せずにリクエストを事前チェックします。システムは、必須パラメーターが指定されているか、リクエストフォーマット、およびサービスの制限を確認します。リクエストが事前チェックに失敗した場合、対応するエラーが返されます。リクエストが事前チェックに合格した場合、DryRunOperation エラーコードが返されます。 false (デフォルト): 通常のリクエストを送信します。リクエストが事前チェックに合格した後、HTTP 2xx 状態コードが返され、操作が実行されます。	false
Ipv6Enabled	boolean	任意	負荷分散がバックエンドサーバーグループにトラフィックを転送するために使用する IP プロトコルバージョンが IPv6 をサポートするかどうかを指定します。有効な値: false (デフォルト): IPv6 はサポートされていません。IPv4 タイプは IPv4 バックエンドサーバーの追加のみをサポートします。 true: デュアルスタックタイプが使用されます。IPv4 と IPv6 の両方のバックエンドサーバーを追加できます。	true
UpstreamKeepaliveEnabled	boolean	任意	バックエンドキープアライブを有効にするかどうかを指定します。有効な値: true: バックエンドキープアライブを有効にします。 false (デフォルト): バックエンドキープアライブを無効にします。	false
ServiceName	string	任意	サーバーグループに対応する `K8s サービス` の名前。このパラメーターは ALB イングレスシナリオにのみ適用されます。	test
UchConfig	object	任意	URL 一貫したハッシュ化パラメータ設定。
Type	string	必須	パラメータータイプ。値を QueryString に設定します。	QueryString
Value	string	必須	一貫したハッシュ化パラメーター値。	abc
ConnectionDrainConfig	object	任意	グレースフル接続中断構成。グレースフル接続中断が有効になると、負荷分散は、バックエンドサーバーが削除されたか、ヘルスチェックが失敗した後、指定された期間内は既存の接続を正常に送信できるようにします。説明 Basic Edition インスタンスはグレースフル接続中断をサポートしていません。Standard Edition および WAF 強化エディションインスタンスのみがこの特徴をサポートしています。サーバータイプおよび IP タイプのサーバーグループはグレースフル接続中断をサポートしています。Function Compute タイプのサーバーグループはこの特徴をサポートしていません。
ConnectionDrainEnabled	boolean	任意	接続ドレインを有効にするかどうかを指定します。有効な値: true: 接続ドレインを有効にします。 false: 接続ドレインを無効にします (デフォルト)。	false
ConnectionDrainTimeout	integer	任意	接続ドレインのタイムアウト期間。有効な値: 0～900。デフォルト値: 300。	300
SlowStartConfig	object	任意	スロースタート構成。スロースタートが有効になると、サーバーグループに新しく追加されたバックエンドサーバーが指定された期間内にウォームアップされ、サーバーに転送されるリクエストの数が直線的に増加します。説明 Basic Edition インスタンスはスロースタートをサポートしていません。Standard Edition および WAF 強化エディションインスタンスのみがこの特徴をサポートしています。サーバータイプおよび IP バックエンドサーバーグループはスロースタートをサポートしています。Function Compute バックエンドサーバーグループはこの特徴をサポートしていません。スロースタートは、バックエンドスケジューリングアルゴリズムが重み付き四捨五入ロビンである場合にのみ有効にできます。
SlowStartEnabled	boolean	任意	スロースタートを有効にするかどうかを指定します。有効な値: true: スロースタートを有効にします。 false: スロースタートを無効にします (デフォルト)。	false
SlowStartDuration	integer	任意	スロースタートの持続時間。有効な値: 30～900。デフォルト値: 30。	30
Tag	array<object>	任意	タグ。
	object	任意	タグ構造。
Key	string	任意	タグキー。キーは最大 128 文字で、`aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。	env
Value	string	任意	タグ値。値は最大 128 文字で、`aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。	product
CrossZoneEnabled	boolean	任意	サーバーグループのクロスゾーン負荷分散を有効にするかどうかを指定します。有効な値: true: クロスゾーン負荷分散を有効にします (デフォルト)。 false: クロスゾーン負荷分散を無効にします。説明 Basic Edition インスタンスは、クロスゾーン負荷分散が無効になっているサーバーグループとの関連付けをサポートしていません。Standard Edition および WAF 強化エディションインスタンスのみがこの特徴をサポートしています。サーバータイプおよび IP タイプのサーバーグループは、クロスゾーン負荷分散の無効化をサポートしています。Function Compute タイプのサーバーグループはこの特徴をサポートしていません。クロスゾーン負荷分散が無効になっている場合、セッション維持を有効にすることはできません。	true
IpVersionAffinityMode	string	任意	IP バージョンアフィニティモード。有効な値: NonAffinity: 非アフィニティモード。これがデフォルト値です。 Affinity: アフィニティモード。このパラメーターは、Ipv6Enabled が true にセットされている場合にのみ効果を発揮します。	Affinity

レスポンスフィールド

フィールド	型	説明	例
	object	応答のデータ構造。
JobId	string	非同期タスクの ID。	72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestId	string	リクエストの ID。	365F4154-92F6-4AE4-92F8-7FF******
ServerGroupId	string	サーバーグループの ID。	sgp-8ilqs4axp6******

例

成功レスポンス

JSONJSON

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF******",
  "ServerGroupId": "sgp-8ilqs4axp6******"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	QuotaExceeded.ServerGroupsNum	The quota of %s is exceeded, usage %s/%s.	クォータ %s を超過しました。現在の使用量は %s で、クォータは %s です。
400	Mismatch.LoadBalancerEditionAndSlowStartEnable	The %s and %s are mismatched.	パラメーター %s と %s が一致しません。
400	Mismatch.ServerGroupSchedulerAndSlowStartEnable	The %s and %s are mismatched.	パラメーター %s と %s が一致しません。
400	QuotaExceeded.SlowStartDuration	The quota of %s is exceeded, usage %s/%s.	パラメーター %s がクォータ制限を超過しています。現在の値は %s で、クォータ値は %s です。
400	UnsupportedFeature.SlowStart	The feature of %s is not supported.	特徴 %s はサポートされていません。
400	Mismatch.LoadBalancerEditionAndConnectionDrain	The %s and %s are mismatched.	パラメーター %s と %s が一致しません。
400	QuotaExceeded.ConnectionDrainTimeout	The quota of %s is exceeded, usage %s/%s.	パラメーター %s がクォータ制限を超過しています。現在の値は %s で、クォータ値は %s です。
400	UnsupportedFeature.ConnectionDrain	The feature of %s is not supported.	特徴 %s はサポートされていません。
400	NotExist.ResourceGroup	ResourceGroup does not exist.	リソースグループが存在しません。
400	OperationDenied.VpcNotSupportIpv6	The operation is not allowed because of VpcNotSupportIpv6.	現在の VPC で IPv6 が有効になっていないため、この操作は許可されていません。
400	UnsupportedFeature.FcServerGroup	Server groups of type FC are not supported.	Function Compute (FC) と ALB の関連付けはサポートされていません。
404	ResourceNotFound.Vpc	The specified resource %s is not found.	VPC が存在しません。

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

変更履歴

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