UpdateServerGroupAttribute でサーバーグループ属性を更新 - Gateway Load Balancer

Server Load Balancer のサーバーグループの属性を更新します。

操作説明

UpdateServerGroupAttribute は非同期操作です。リクエストを送信すると、システムはリクエスト ID を返し、タスクをバックグラウンドで実行します。サーバーグループの構成は即時に更新されません。サーバーグループの状態を確認するには、ListServerGroups 操作を呼び出してください。

サーバーグループの状態が Configuring の場合、その構成は現在更新中です。
サーバーグループの状態が 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

gwlb:UpdateServerGroupAttribute

update

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ServerGroupId	string	必須	サーバーグループの ID。	sgp-atstuj3rtoptyui****
ServerGroupName	string	任意	サーバーグループの名前。名前の長さは 2～128 文字で、英字または漢字で始める必要があります。また、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができます。	testServerGroupName
Scheduler	string	任意	スケジューリングアルゴリズム。有効な値： 5TCH：5 次元ルールによるハッシュ化。パケットは、送信元 IP アドレス、宛先 IP アドレス、送信元ポート、宛先ポート、およびプロトコルの 5 次元ルールに基づくハッシュ値によってバックエンドサーバーに分散されます。これにより、同一のストリームは常に同一のバックエンドサーバーにスケジュールされます。 3TCH：3 次元ルールによるハッシュ化。パケットは、送信元 IP アドレス、宛先 IP アドレス、およびプロトコルの 3 次元ルールに基づくハッシュ値によってバックエンドサーバーに分散されます。これにより、同一のストリームは常に同一のバックエンドサーバーにスケジュールされます。 2TCH：2 次元ルールによるハッシュ化。パケットは、送信元 IP アドレスおよび宛先 IP アドレスの 2 次元ルールに基づくハッシュ値によってバックエンドサーバーに分散されます。これにより、同一のストリームは常に同一のバックエンドサーバーにスケジュールされます。	5TCH
ServerFailoverMode	string	任意	バックエンドサーバーが異常状態になった際に、既存の接続をどのように処理するかを指定します。有効な値： NoRebalance：既存の接続は再分散されません。 Rebalance：既存の接続は再分散されます。	NoRebalance
ConnectionDrainConfig	object	任意	接続ドレインの構成。
ConnectionDrainEnabled	boolean	任意	接続ドレインを有効にするかどうかを指定します。有効な値： true false	false
ConnectionDrainTimeout	integer	任意	接続ドレインのタイムアウト期間。単位：秒。有効な値： 1～3600。	300
HealthCheckConfig	object	任意	ヘルスチェックの構成。
HealthCheckConnectPort	integer	任意	バックエンドサーバーに対するヘルスチェックで使用されるポート。有効な値： 1～65535。	80
HealthCheckConnectTimeout	integer	任意	ヘルスチェック応答の最大タイムアウト期間。単位：秒。有効な値： 1～300。	5
HealthCheckDomain	string	任意	ヘルスチェックで使用されるドメイン名。有効な値： $SERVER_IP：バックエンドサーバーのプライベート IP アドレス。 domain：指定されたドメイン名。ドメイン名は 1～80 文字で、英字、数字、ハイフン (-)、ピリオド (.) を含めることができます。説明このパラメーターは、HealthCheckProtocol が HTTP に設定されている場合のみ有効です。	$SERVER_IP
HealthCheckEnabled	boolean	任意	ヘルスチェックを有効にするかどうかを指定します。有効な値： true false	true
HealthCheckHttpCode	array	任意	正常状態を示す HTTP ステータスコードのリスト。
	string	任意	正常状態を示す HTTP ステータスコード。複数の HTTP ステータスコードを指定できます。複数のステータスコードはカンマ (,) で区切ります。有効な値： http_2xx：HTTP 2xx ステータスコードは正常状態を示します。 http_3xx：HTTP 3xx ステータスコードは正常状態を示します。 http_4xx：HTTP 4xx ステータスコードは正常状態を示します。 http_5xx：HTTP 5xx ステータスコードは正常状態を示します。デフォルト値： http_2xx。説明このパラメーターは、HealthCheckProtocol が HTTP に設定されている場合のみ有効です。	http_2xx
HealthCheckInterval	integer	任意	ヘルスチェックを実行する間隔。単位：秒。有効な値： 1～50。	10
HealthCheckPath	string	任意	ヘルスチェックで使用されるパス。パスの長さは 1～80 文字で、英字、数字、および以下の特殊文字：`-/.%?#&` を含めることができます。パスはスラッシュ (/) で始める必要があります。説明このパラメーターは、HealthCheckProtocol が HTTP に設定されている場合のみ有効です。	/test/index.html
HealthCheckProtocol	string	任意	ヘルスチェックで使用されるプロトコル。有効な値： TCP：TCP SYN パケットをバックエンドサーバーに送信して、バックエンドサーバーのポートが到達可能であるかどうかを確認します。 HTTP：GET リクエストをバックエンドサーバーに送信して、サーバーアプリケーションが正常であるかどうかを確認します。	TCP
HealthyThreshold	integer	任意	バックエンドサーバーのヘルスチェックステータスを失敗したから成功したに変更するために必要な、連続した成功したヘルスチェックの回数。有効な値： 2～10。	2
UnhealthyThreshold	integer	任意	バックエンドサーバーのヘルスチェックステータスを成功したから失敗したに変更するために必要な、連続した失敗したヘルスチェックの回数。有効な値： 2～10。	2
HealthCheckReq	string	任意
HealthCheckExp	string	任意
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効な値： true：ドライランを実行します。システムは必須パラメーター、リクエストフォーマット、およびサービス制限をチェックします。リクエストがドライランに失敗した場合、エラーメッセージが返されます。リクエストがドライランに合格した場合、`DryRunOperation` エラーコードが返されます。 false（デフォルト）：ドライランを実行し、リクエストを送信します。リクエストがドライランに合格した場合、2xx の HTTP ステータスコードが返され、操作が実行されます。	false
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアント側でトークンを生成できますが、異なるリクエスト間でトークンが一意であることを保証する必要があります。トークンには ASCII 文字のみを使用できます。説明このパラメーターを指定しない場合、システムは自動的にリクエストの RequestId を ClientToken として使用します。RequestId は各リクエストごとに異なる場合があります。	123e4567-e89b-12d3-a456-42665544****

レスポンスフィールド

フィールド	型	説明	例
	object	応答データ。
RequestId	string	リクエスト ID。	54B48E3D-DF70-471B-AA93-08E683A1B45

例

成功レスポンス

JSONJSON

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45\n"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	IllegalParam.HealthCheckProtocol	The param of %s is illegal.
400	IncorrectStatus.ServerGroup	The status of %s [%s] is incorrect.
400	OperationDenied.SchedulerNotConfigurable	The scheduling algorithm of server group is configurable only when TCP idle timeout of listener is default value.
404	ResourceNotFound.ServerGroup	The specified resource of %s is not found.

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

変更履歴

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