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

サーバーグループ内のバックエンドサーバーの重みや説明などの構成を更新します。

操作説明

UpdateServerGroupServersAttribute は非同期操作です。リクエストを送信すると、システムはリクエスト ID を返し、バックグラウンドでタスクを実行します。バックエンドサーバーの構成はリアルタイムでは更新されません。

ListServerGroups 操作を呼び出して、サーバーグループのステータスをクエリできます。
- サーバーグループが 設定中 状態の場合、グループは変更中です。
- サーバーグループが 利用可能 状態の場合、グループは実行中です。
ListServerGroupServers 操作を呼び出して、バックエンドサーバーのステータスをクエリできます。
- バックエンドサーバーが 設定中 状態の場合、サーバーは変更中です。
- バックエンドサーバーが 利用可能 状態の場合、サーバーは実行中です。

今すぐお試しください

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

update

*ServerGroup

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

*Instance

acs:ecs:{#regionId}:{#accountId}:ecs/{#ecsId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ServerGroupId	string	必須	サーバーグループの ID。	sgp-atstuj3rtop****
Servers	array<object>	必須	バックエンドサーバー。呼び出しごとに最大 40 台のサーバーを指定できます。
	object	任意	バックエンドサーバー。
Description	string	任意	バックエンドサーバーの説明。説明は 2～256 文字である必要があり、http:// または https:// で始めることはできません。	test
Port	integer	任意	バックエンドサーバーが使用するポート。有効な値: 1～65535。説明 ServerType が Fc に設定されている場合、このパラメーターは必須ではありません。	80
ServerId	string	必須	バックエンドサーバーの ID。 ServerType を Ecs、Eni、または Eci に設定した場合は、このパラメーターを ECS インスタンス、Elastic Network Interface (ENI)、または Elastic Container Instance (ECI) の ID に設定します。 ServerType を Ip に設定した場合は、このパラメーターを IP アドレスに設定します。 ServerType を Fc に設定した場合は、このパラメーターを Function Compute 関数の Alibaba Cloud リソースネーム (ARN) に設定します。	i-bp1f9kdprbgy9uiu****
ServerIp	string	任意	IP アドレス。	192.168.1.1
ServerType	string	必須	バックエンドサーバーのタイプ。有効な値: Ecs: ECS インスタンス。 Eni: ENI。 Eci: ECI。 Ip: IP アドレス。 Fc: Function Compute 関数。	Ecs
Weight	integer	任意	バックエンドサーバーの重み。有効な値: 0～100。デフォルト値: 100。重みを 0 に設定した場合、リクエストはバックエンドサーバーに転送されません。説明 ServerType が Fc に設定されている場合、このパラメーターは必須ではありません。	100
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。異なるリクエスト間で一意のトークンを生成します。トークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムはリクエストの RequestId を ClientToken として使用します。各リクエストの RequestId は一意です。	593B0448-D13E-4C56-AC0D-FDF0******
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効な値: true: ドライランを実行します。システムは、必須パラメーター、リクエストフォーマット、およびサービス制限をチェックしますが、バックエンドサーバーの重みや説明などの構成は更新しません。リクエストがドライランに失敗すると、エラーメッセージが返されます。リクエストがドライランに合格すると、`DryRunOperation` エラーコードが返されます。 false (デフォルト): 通常のリクエストを送信します。リクエストがチェックに合格すると、システムは HTTP 2xx ステータスコードを返し、操作を完了します。	false

レスポンスフィールド

フィールド	型	説明	例
	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	ResourceInConfiguring	The specified resource of %s is being configured. Please try again later.
403	Forbidden.ServerGroup	Authentication has failed for ServerGroup.
404	ResourceNotFound.ServerGroup	The specified resource %s is not found.
404	ResourceNotFound.BackendServer	The specified resource %s is not found.

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

変更履歴

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