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

サーバーグループのヘルスチェック、セッション維持、サーバーグループ名、ルーティングアルゴリズム、プロトコルなどの構成を変更します。

操作説明

説明

UpdateServerGroupAttribute は非同期操作です。リクエストの送信後、システムはリクエスト ID を返し、バックグラウンドでタスクを実行します。ListServerGroups 操作を呼び出して、サーバーグループのステータスをクエリできます。

サーバーグループが 設定中 状態の場合、サーバーグループの構成が変更中です。
サーバーグループが 利用可能 状態の場合、サーバーグループの構成は変更済みです。

今すぐお試しください

この 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：重み付き最小接続アルゴリズム。リクエストは、重みとバックエンドサーバーへの接続数に基づいて分散されます。2 つのバックエンドサーバーの重みが同じ場合、接続数が少ないバックエンドサーバーがより多くのリクエストを受け取ることが想定されます。 Sch：一貫性ハッシュアルゴリズム。同じ送信元 IP アドレスからのリクエストは、同じバックエンドサーバーに分散されます。	Wrr
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは自動的にリクエスト ID をクライアントトークンとして使用します。リクエスト ID はリクエストごとに異なる場合があります。	5A2CFF0E-5718-45B5-9D4D-70B3******
DryRun	boolean	任意	実際のリクエストを実行せずに、ドライランのみを実行するかどうかを指定します。有効値： true：操作を実行せずにリクエストをチェックします。システムは、不足しているパラメーター値、不正なリクエスト構文、サービス制限など、リクエストの潜在的な問題をチェックします。リクエストがドライランに失敗した場合、エラーコードが返されます。リクエストがドライランに合格した場合、`DryRunOperation` エラーコードが返されます。 false (デフォルト)：ドライランを実行し、実際のリクエストを実行します。リクエストがドライランに合格した場合、`2xx` HTTP ステータスコードが返され、操作が実行されます。	true
HealthCheckConfig	object	任意	ヘルスチェックの構成。
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	任意	正常なバックエンドサーバーを示す HTTP ステータスコード。 HealthCheckProtocol が HTTP または HTTPS に設定されている場合、HealthCheckCodes を http_2xx (デフォルト値)、http_3xx、http_4xx、および http_5xx に設定できます。複数の HTTP ステータスコードはコンマ (,) で区切ります。 HealthCheckProtocol が gRPC に設定されている場合、HealthCheckCodes の有効値は 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	任意	ヘルスチェックに使用される HTTP メソッド。有効値： GET：応答の長さが 8 KB を超える場合、応答は切り捨てられます。ただし、ヘルスチェックの結果には影響しません。 POST：gRPC ヘルスチェックはデフォルトで POST メソッドを使用します。 HEAD：HTTP および HTTPS ヘルスチェックはデフォルトで HEAD メソッドを使用します。説明このパラメーターは、HealthCheckEnabled を true に設定し、HealthCheckProtocol を HTTP、HTTPS、または gRPC に設定した場合にのみ有効になります。	HEAD
HealthCheckPath	string	任意	ヘルスチェックに使用される URL。 URL は 1～80 文字の長さで、文字、数字、および次の特殊文字を含めることができます：`- / . % ? # & =`。また、次の拡張文字を含めることもできます：`_ ; ~ ! ( ) * [ ] @ $ ^ : ' , +`。URL はスラッシュ (`/`) で始まる必要があります。説明このパラメーターは、HealthCheckEnabled を true に設定し、HealthCheckProtocol を HTTP または HTTPS に設定した場合にのみ有効になります。	/test/index.html
HealthCheckProtocol	string	任意	ヘルスチェックに使用するプロトコル。有効値： HTTP：HTTP ヘルスチェックは、HEAD または GET リクエストを送信してバックエンドサーバーの可用性を調査することで、ブラウザの動作をシミュレートします。 HTTPS：HTTPS ヘルスチェックは、HEAD または GET リクエストを送信してバックエンドサーバーの可用性を調査することで、ブラウザの動作をシミュレートします。HTTPS は暗号化をサポートし、HTTP よりも高いセキュリティを提供します。 TCP：TCP ヘルスチェックは、TCP SYN パケットをバックエンドサーバーに送信して、バックエンドサーバーの可用性を調査します。 gRPC：gRPC ヘルスチェックは、POST または GET リクエストをバックエンドサーバーに送信して、バックエンドサーバーが正常であるかどうかを確認します。	HTTP
HealthCheckTimeout	integer	任意	ヘルスチェック応答のタイムアウト期間。バックエンドの ECS インスタンスが指定されたタイムアウト期間内に応答しない場合、ECS インスタンスはヘルスチェックに失敗します。単位：秒。有効値：1～300。説明このパラメーターは、HealthCheckEnabled を true に設定した場合にのみ有効になります。	3
HealthyThreshold	integer	任意	異常なバックエンドサーバーが正常と宣言されるまでに連続してヘルスチェックに合格する必要がある回数。この場合、バックエンドサーバーのヘルスチェックステータスは fail から success に変わります。有効値：2～10。	4
UnhealthyThreshold	integer	任意	正常なバックエンドサーバーが異常と宣言されるまでに連続してヘルスチェックに失敗する必要がある回数。この場合、バックエンドサーバーのヘルスチェックステータスは success から fail に変わります。有効値：2～10。	4
StickySessionConfig	object	任意	セッション維持の構成。
Cookie	string	任意	サーバーに設定するクッキー。クッキーは 1～200 文字の長さで、ASCII 文字と数字のみを含めることができます。コンマ (,)、セミコロン (;)、またはスペース文字を含めることはできません。ドル記号 ($) で始めることはできません。説明このパラメーターは、StickySessionEnabled パラメーターが true に設定され、StickySessionType パラメーターが Server に設定されている場合に有効になります。	B490B5EBF6F3CD402E515D22B******
CookieTimeout	integer	任意	クッキーのタイムアウト期間。単位：秒。有効値：1～86400。説明このパラメーターは、StickySessionEnabled パラメーターが true に設定され、StickySessionType パラメーターが Insert に設定されている場合に有効になります。	1000
StickySessionEnabled	boolean	任意	セッション維持を有効にするかどうかを指定します。有効値： true false (デフォルト)	false
StickySessionType	string	任意	クッキーを処理するために使用されるメソッド。有効値： Insert：クッキーを挿入します。 ALB は、クライアントに送信される最初の HTTP または HTTPS 応答パケットにクッキー (SERVERID) を挿入します。クライアントからの次のリクエストにはこのクッキーが含まれ、リスナーはこのリクエストを記録されたバックエンドサーバーに転送します。 Server：クッキーを再書き込みします。 ALB がユーザー定義のクッキーを検出すると、元のクッキーをユーザー定義のクッキーで上書きします。ALB への後続のリクエストにはこのユーザー定義のクッキーが含まれ、ALB はクッキーに基づいてリクエストの宛先サーバーを決定します。説明このパラメーターは、サーバーグループに対して StickySessionEnabled パラメーターが true に設定されている場合に有効になります。	Insert
ServerGroupId	string	必須	サーバーグループ ID。	sgp-atstuj3rtop****
UpstreamKeepaliveEnabled	boolean	任意	TCP 持続的接続を有効にするかどうかを指定します。
ServiceName	string	任意	このパラメーターは、ALB Ingress コントローラーを使用する場合にのみ使用できます。この場合、このパラメーターをサーバーグループに関連付けられている `Kubernetes Service` の名前に設定します。	test2
UchConfig	object	任意	URL に基づく一貫性ハッシュの構成。
Type	string	必須	パラメーターのタイプ。クエリ文字列のみがサポートされています。	QueryString
Value	string	必須	一貫性ハッシュに使用されるパラメーターの値。	abc
ConnectionDrainConfig	object	任意	接続ドレインの構成。接続ドレインが有効になった後、バックエンドサーバーが削除されたり異常と宣言されたりした後も、SLB は一定期間データ転送を維持します。説明 Basic SLB インスタンスは接続ドレインをサポートしていません。Standard および WAF-enabled SLB インスタンスは接続ドレインをサポートしています。サーバーおよび IP タイプのサーバーグループは接続ドレインをサポートしています。Function Compute タイプのサーバーグループは接続ドレインをサポートしていません。
ConnectionDrainEnabled	boolean	任意	接続ドレインを有効にするかどうかを指定します。有効値： true false	false
ConnectionDrainTimeout	integer	任意	接続ドレインのタイムアウト期間。有効値：0～900。	300
SlowStartConfig	object	任意	スロースタートの構成。スロースタートが有効になった後、ALB は新しく追加されたバックエンドサーバーにデータをプリフェッチします。バックエンドサーバーに分散されるリクエストは徐々に増加します。説明 Basic ALB インスタンスはスロースタートをサポートしていません。Standard および WAF-enabled ALB インスタンスはスロースタートをサポートしています。インスタンスおよび IP タイプのサーバーグループはスロースタートをサポートしています。Function Compute タイプのサーバーグループはスロースタートをサポートしていません。スロースタートは、重み付きラウンドロビンスケジューリングアルゴリズムでのみサポートされています。
SlowStartEnabled	boolean	任意	スロースタートが有効になっているかどうかを示します。有効値： true false	false
SlowStartDuration	integer	任意	スロースタートの期間。	30
CrossZoneEnabled	boolean	任意	サーバーグループでクロスゾーン負荷分散が有効になっているかどうかを示します。有効値： true (デフォルト) false 説明 Basic ALB インスタンスは、クロスゾーン負荷分散が無効になっているサーバーグループをサポートしていません。Standard および WAF-enabled ALB インスタンスのみが、クロスゾーン負荷分散が有効なサーバーグループをサポートしています。クロスゾーン負荷分散は、サーバーおよび IP タイプのサーバーグループでは無効にできますが、Function Compute タイプのサーバーグループでは無効にできません。クロスゾーン負荷分散が無効になっている場合、セッション維持を有効にすることはできません。	true

レスポンスフィールド

フィールド	型	説明	例
	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.

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

変更履歴

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