AttachServerGroups - Auto Scaling - Alibaba Cloud ドキュメントセンター

スケーリンググループに 1 つ以上の負荷分散サーバーグループを追加します。サポートされるサーバーグループのタイプには、Application Load Balancer (ALB) および Network Load Balancer (NLB) があります。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ess:AttachServerGroups

update

*スケーリンググループ。

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	スケーリンググループのリージョン ID。	cn-hangzhou
ScalingGroupId	string	必須	スケーリンググループの ID。	asg-bp18p2yfxow2dloq****
ClientToken	string	任意	リクエストのべき等性を保証します。クライアントがパラメーター値を生成し、異なるリクエスト間で値が一意になるようにします。値には ASCII 文字のみ使用でき、長さは 64 文字以下です。詳細については、「べき等性を確保する方法」を参照してください。	123e4567-e89b-12d3-a456-42665544****
ForceAttach	boolean	任意	現在のスケーリンググループ内の ECS インスタンスまたは ECI インスタンスを、新規に追加するサーバーグループに追加するかどうかを指定します。有効な値: true: インスタンスを追加します。 false: インスタンスを追加しません。デフォルト値: false。	false
ServerGroup	array<object>	必須	負荷分散サーバーグループの詳細。
	object	任意	負荷分散サーバーグループの詳細。
ServerGroupId	string	必須	負荷分散サーバーグループの ID。	sgp-60ofsqhwer0b***
Type	string	必須	負荷分散サーバーグループのタイプ。有効な値: ALB: Application Load Balancer (ALB)。 NLB: Network Load Balancer (NLB)。 GWLB: Gateway Load Balancer (GWLB)。	ALB
Weight	integer	任意	Auto Scaling によってインスタンスがサーバーグループに追加された後の、バックエンドサーバーとしての ECS インスタンスまたは ECI インスタンスの重み。有効な値: 0～100。重みが大きいほど、システムはより多くのアクセスリクエストを ECS インスタンスまたは ECI インスタンスに割り当てることになります。重みが 0 にセットされている場合、ECS インスタンスまたは ECI インスタンスはアクセスリクエストを受信しません。説明このパラメーターは ALB および NLB の負荷分散で必須です。GWLB の負荷分散では、このパラメーターの設定項目はサポートされていません。	100
Port	integer	任意	Auto Scaling によってインスタンスがサーバーグループに追加された後に ECS インスタンスまたは ECI インスタンスが使用するポート番号。有効な値: 1～65535。説明このパラメーターは ALB および NLB の負荷分散で必須です。GWLB の負荷分散では、このパラメーターの設定項目はサポートされておらず、デフォルト値は 6081 です。	22

レスポンスフィールド

フィールド	型	説明	例
	object
ScalingActivityId	string	負荷分散サーバーグループが追加され、スケーリンググループ内の ECS インスタンスまたは ECI インスタンスがサーバーグループに追加されたときにトリガーされるスケーリングアクティビティの ID。説明このパラメーターは、ForceAttach が true にセットされている場合にのみ返されます。	asa-bp1c9djwrgxjyk31****
RequestId	string	リクエストの ID。	74C4E313-8570-479F-8791-DC25360D****

例

成功レスポンス

JSONJSON

{
  "ScalingActivityId": "asa-bp1c9djwrgxjyk31****",
  "RequestId": "74C4E313-8570-479F-8791-DC25360D****"
}

エラーコード

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

変更履歴

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