UpdateServerGroupAttribute - - Alibaba Cloud ドキュメントセンター

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	任意	バックエンドサーバーのヘルスチェックステータスを failed から successful に変更するために必要な、連続して成功するヘルスチェックの数。有効な値： 2 ～ 10。	2
UnhealthyThreshold	integer	任意	バックエンドサーバーのヘルスチェックステータスを successful から failed に変更するために必要な、連続して失敗するヘルスチェックの数。有効な値： 2 ～ 10。	2
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.

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

変更履歴

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