UpdateServerGroupAttribute を呼び出してサーバグループ設定を変更 - SLB - Alibaba Cloud - Server Load Balancer

サーバーグループのヘルスチェック、セッション維持、名前、スケジューリングアルゴリズム、プロトコルなどの設定を更新します。

操作説明

UpdateServerGroupAttribute API は非同期です。この API を呼び出すと、システムはリクエスト ID を返し、バックグラウンドで更新を実行します。設定の変更はすぐには反映されません。ListServerGroups API を呼び出して、サーバーグループのステータスをクエリすることができます。

ステータスが設定中の場合、サーバーグループが更新中であることを示します。
ステータスが利用可能の場合、更新が完了したことを示します。

今すぐお試しください

この 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:UpdateServerGroupAttribute

update

*ServerGroup

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ServerGroupName	string	任意	サーバーグループの名前。名前は 2～128 文字で、英字、数字、または中国語文字で始まる必要があります。英字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-)、およびスペースを使用できます。	test
Scheduler	string	任意	スケジューリングアルゴリズム。有効な値： Wrr：重み付きラウンドロビン。重みが大きいバックエンドサーバーほど、多くのリクエストを受け取ります。 Wlc：重み付き最小接続。このアルゴリズムは、各バックエンドサーバーの重みと現在の負荷 (接続数) の両方に基づいてリクエストをルーティングします。バックエンドサーバーの重みが同じ場合、アクティブな接続が少ないバックエンドサーバーほど、多くのリクエストを受け取ります。 Sch：コンシステントハッシュ。デフォルトでは、送信元 IP アドレスがハッシュキーとして使用されます。`UchConfig` パラメータを設定した場合は、代わりに URL パラメータがハッシュキーとして使用されます。	Wrr
ClientToken	string	任意	リクエストのべき等性を確保するために使用するクライアントトークン。クライアント側で一意の値を生成し、リクエストごとに一意であることを確認してください。クライアントトークンには ASCII 文字のみを含めることができます。説明このパラメータを指定しない場合、システムは API リクエストの RequestId をクライアントトークンとして使用します。	5A2CFF0E-5718-45B5-9D4D-70B3******
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効な値： true：ドライランを実行し、リソースを変更せずにリクエストの有効性を確認します。システムは必須パラメータ、リクエスト形式、サービス制限を確認します。チェックが成功すると、`DryRunOperation` エラーコードが返されます。 false (デフォルト)：通常のリクエストを送信します。リクエストが有効な場合、操作が実行され、HTTP `2xx` ステータスコードが返されます。	true
HealthCheckConfig	object	任意	ヘルスチェックの設定。	true
HealthCheckConnectPort	integer	任意	ヘルスチェックに使用するバックエンドサーバーのポート。有効な値：0～65535。この値を 0 に設定した場合、バックエンドサーバーのポートがヘルスチェックに使用されます。説明このパラメータは、HealthCheckEnabled が true に設定されている場合にのみ有効です。	80
HealthCheckEnabled	boolean	任意	ヘルスチェックを有効にするかどうかを指定します。有効な値： true：ヘルスチェックを有効にします。 false：ヘルスチェックを無効にします。	true
HealthCheckHost	string	任意	ヘルスチェックに使用するドメイン名。バックエンドサーバーのプライベート IP アドレスを使用 (デフォルト)：バックエンドサーバーのプライベート IP アドレスがヘルスチェックに使用されます。ドメイン名を指定：次の要件を満たすドメイン名を入力します：ドメイン名は 1～80 文字である必要があります。小文字の英字、数字、ハイフン (-)、およびピリオド (.) を含めることができます。少なくとも 1 つのピリオド (.) を含める必要があります。先頭または末尾の文字にすることはできません。一番右のドメインラベルは英字のみを含めることができ、数字またはハイフン (-) を含めることはできません。ハイフン (-) を先頭または末尾の文字にすることはできません。説明このパラメータは、HealthCheckProtocol が HTTP、HTTPS、または gRPC に設定されている場合にのみ有効です。	example.com
HealthCheckCodes	array	任意	ヘルスチェックが成功したことを示す HTTP ステータスコード。
	string	任意	ヘルスチェックが成功したことを示すステータスコード。 HealthCheckProtocol が HTTP または HTTPS に設定されている場合、http_2xx (デフォルト)、http_3xx、http_4xx、および http_5xx を指定できます。複数の値はコンマ (,) で区切ります。 HealthCheckProtocol が gRPC に設定されている場合、有効なステータスコードは 0～99 です。デフォルト値は 0 です。最大 20 個の範囲を指定できます。複数の範囲はコンマ (,) で区切ります。説明このパラメータは、HealthCheckEnabled が true に設定されており、かつ HealthCheckProtocol が HTTP、HTTPS、または gRPC に設定されている場合にのみ有効です。	200
HealthCheckHttpVersion	string	任意	ヘルスチェックに使用する HTTP バージョン。有効な値： HTTP1.0 HTTP1.1 説明このパラメータは、HealthCheckEnabled が true に設定されており、かつ HealthCheckProtocol が HTTP または HTTPS に設定されている場合にのみ有効です。	HTTP1.1
HealthCheckInterval	integer	任意	ヘルスチェックの間隔 (秒)。有効な値：1～50。説明このパラメータは、HealthCheckEnabled が true に設定されている場合にのみ有効です。	5
HealthCheckMethod	string	任意	ヘルスチェックに使用するメソッド。有効な値： GET：レスポンスボディが 8 KB を超える場合、切り捨てられます。これはヘルスチェック結果に影響しません。 POST：デフォルトでは、gRPC リスナーはヘルスチェックに POST を使用します。 HEAD：デフォルトでは、HTTP および HTTPS リスナーはヘルスチェックに HEAD を使用します。説明このパラメータは、HealthCheckEnabled が true に設定されており、かつ HealthCheckProtocol が HTTP、HTTPS、または gRPC に設定されている場合にのみ有効です。	HEAD
HealthCheckPath	string	任意	ヘルスチェックリクエストの送信先パス。パスは 1～80 文字である必要があります。英字、数字、および次の文字を含めることができます：`-/.%?#&=` と `_~;!()[]@$^:',+`。パスは `/` で始まる必要があります。説明このパラメータは、HealthCheckEnabled* が true に設定されており、かつ 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。説明このパラメータは、HealthCheckEnabled が true に設定されている場合にのみ有効です。	3
HealthyThreshold	integer	任意	サーバーのステータスが fail から success に変わるまでに必要な、連続して成功したヘルスチェック回数。有効な値：2～10。	4
UnhealthyThreshold	integer	任意	サーバーのステータスが success から fail に変わるまでに必要な、連続して失敗したヘルスチェック回数。有効な値：2～10。	4
StickySessionConfig	object	任意	スティッキーセッションの設定。
Cookie	string	任意	サーバーに設定される Cookie。 Cookie は 1～200 文字の長さで、ASCII 文字で構成されている必要があります。コンマ (,)、セミコロン (;)、スペースを含んだり、ドル記号 ($) で始めたりすることはできません。説明このパラメータは、StickySessionEnabled が true に設定されており、かつ StickySessionType が Server に設定されている場合にのみ有効です。	B490B5EBF6F3CD402E515D22B******
CookieTimeout	integer	任意	Cookie タイムアウト (秒)。有効な値：1～86400。説明このパラメータは、StickySessionEnabled が true に設定されており、かつ StickySessionType が Insert に設定されている場合にのみ有効です。	1000
StickySessionEnabled	boolean	任意	スティッキーセッションを有効にするかどうかを指定します。有効な値： true：スティッキーセッションを有効にします。 false：スティッキーセッションを無効にします。	false
StickySessionType	string	任意	Cookie の処理方法。有効な値： Insert：ロードバランサーは、クライアントからの最初のリクエストに対する HTTP または HTTPS レスポンスに Cookie (SERVERID) を挿入します。以降、クライアントがこの Cookie を含むリクエストを送信すると、同じバックエンドサーバーにルーティングされます。 Server：ユーザー定義の Cookie を検出すると、ロードバランサーは元の Cookie を上書きします。以降、クライアントが新しい Cookie を含むリクエストを送信すると、同じバックエンドサーバーにルーティングされます。説明このパラメータは、StickySessionEnabled が true に設定されている場合にのみ有効です。	Insert
ServerGroupId	string	必須	サーバーグループの ID。	sgp-atstuj3rtop****
UpstreamKeepaliveEnabled	boolean	任意	バックエンドサーバーへの持続的接続を有効にするかどうかを指定します。 true：持続的接続を有効にします。 false：持続的接続を無効にします。	sgp-123
ServiceName	string	任意	対応する Kubernetes (K8s) `Service` の名前。このパラメータは、Application Load Balancer (ALB) Ingress のシナリオにのみ適用されます。	test2
UchConfig	object	任意	URL ベースのコンシステントハッシュの設定。
Type	string	必須	パラメータのタイプ。`QueryString` のみサポートされています。	QueryString
Value	string	必須	コンシステントハッシュに使用するクエリストリングパラメータの名前。	abc
ConnectionDrainConfig	object	任意	コネクションドレイニングの設定。コネクションドレイニングを有効にすると、バックエンドサーバーが削除された場合、または非正常と判断された場合に、ロードバランサーは、指定された期間、既存の接続の処理を継続します。説明 Basic インスタンスはコネクションドレイニングをサポートしていません。Standard インスタンスと WAF-enhanced インスタンスのみがこの機能をサポートします。インスタンスタイプおよびIPタイプのサーバーグループは、コネクションドレイニングをサポートします。Function Compute タイプのサーバーグループはサポートしていません。
ConnectionDrainEnabled	boolean	任意	コネクションドレイニングを有効にするかどうかを指定します。 true：コネクションドレイニングを有効にします。 false：コネクションドレイニングを無効にします。	false
ConnectionDrainTimeout	integer	任意	コネクションドレイニングタイムアウト (秒)。有効な値：0～900。	300
SlowStartConfig	object	任意	スロースタートの設定。スロースタートを有効にすると、ロードバランサーは指定した期間にわたり、新しく追加されたバックエンドサーバーをウォームアップします。このウォームアップ期間中、サーバーにルーティングされるリクエスト数は線形に増加します。説明 Basic インスタンスはスロースタートをサポートしていません。Standard インスタンスと WAF-enhanced インスタンスのみがこの機能をサポートします。インスタンスタイプおよびIPタイプのサーバーグループはスロースタートをサポートします。Function Compute タイプのサーバーグループはサポートしていません。スロースタートを有効にできるのは、スケジューリングアルゴリズムが重み付きラウンドロビンの場合のみです。
SlowStartEnabled	boolean	任意	スロースタートを有効にするかどうかを指定します。 true：スロースタートを有効にします。 false：スロースタートを無効にします。	false
SlowStartDuration	integer	任意	スロースタート期間 (秒)。有効な値：30～900。	30
CrossZoneEnabled	boolean	任意	サーバーグループでクロスゾーン負荷分散を有効にするかどうかを指定します。有効な値： true (デフォルト)：クロスゾーン負荷分散を有効にします。 false：クロスゾーン負荷分散を無効にします。説明 Basic インスタンスではクロスゾーン負荷分散を有効にする必要があります。無効化できるのは Standard インスタンスと WAF-enhanced インスタンスのみです。インスタンスタイプおよびIPタイプのサーバーグループでは、クロスゾーン負荷分散の無効化がサポートされています。Function Compute タイプのサーバーグループではサポートされていません。クロスゾーン負荷分散が無効の場合、スティッキーセッションを有効にできません。	true
IpVersionAffinityMode	string	任意	IP バージョンアフィニティモード。	Affinity

レスポンスフィールド

フィールド	型	説明	例
	object	応答データです。
JobId	string	非同期タスクの ID です。	72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestId	string	リクエストの ID です。	365F4154-92F6-4AE4-92F8-7FF3*****

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	IncorrectStatus.ServerGroup	The status of %s [%s] is incorrect.
400	Mismatch.LoadBalancerEditionAndConnectionDrain	The %s and %s are mismatched.
400	Mismatch.ServerGroupSchedulerAndSlowStartEnable	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	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.LoadBalancerEditionAndSlowStartEnable	The %s and %s are mismatched.
400	OperationDenied.UpstreamKeepaliveDisabled	The operation is not allowed because of UpstreamKeepaliveDisabled.
400	OperationDenied.UpstreamKeepaliveEnabled	The operation is not allowed because of UpstreamKeepaliveEnabled.
400	CloseUpstreamKeepaliveNotSupport	The param of UpstreamKeepalive is not Support.
404	ResourceNotFound.ServerGroup	The specified resource %s is not found.

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

変更履歴

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