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

インスタンスをスケーリンググループに追加してサービスを提供するか、エコノミーモードで停止している Elastic Compute Service (ECS) インスタンスを再起動してサービスを再開します。AttachInstances API を呼び出すと、ECS インスタンス、Elastic Container Instance、または Alibaba Cloud が管理するサードパーティインスタンスをスケーリンググループに追加してサービスを提供できます。また、この API を呼び出して、スケーリンググループ内のエコノミーモードで停止している ECS インスタンスを再起動し、サービスを提供することもできます。

今すぐお試しください

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

update

*ScalingGroup

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ScalingGroupId	string	必須	スケーリンググループの ID。	asg-bp18p2yfxow2dloq****
Entrusted	boolean	任意	手動で追加されたインスタンスのライフサイクルをスケーリンググループが管理するかどうかを指定します。有効な値： true：スケーリンググループは、手動で追加されたインスタンスと自動で作成されたインスタンスのライフサイクルを同じ方法で管理します。この場合、Auto Scaling はインスタンスがスケーリンググループから削除されると、そのインスタンスをリリースします。このルールは、DetachInstances API を呼び出して削除されたインスタンスには適用されません。 false：スケーリンググループは、手動で追加されたインスタンスのライフサイクルを管理しません。この場合、Auto Scaling はインスタンスがスケーリンググループから削除されても、そのインスタンスをリリースしません。説明このパラメーターは、サブスクリプションインスタンス、Alibaba Cloud 以外のインスタンス、およびエコノミーモードのインスタンスには指定できません。デフォルト値： false。	false
InstanceIds	array	任意	ECS インスタンス、Elastic Container Instance、Alibaba Cloud 以外のインスタンス、またはエコノミーモードのインスタンスの ID。
	string	任意	ECS インスタンス、Elastic Container Instance、Alibaba Cloud 以外のインスタンス、またはエコノミーモードのインスタンスの ID。 ID の例： ECS インスタンス： i-28wt4**。 Elastic Container Instance： eci-bp17gw49eu09yiwm。 Alibaba Cloud 以外のインスタンス： mi-2cx*。エコノミーモードの ECS インスタンス： i-2cd2f**。説明 1 回の呼び出しで、同じタイプのインスタンスのみスケーリンググループに追加できます。	i-28wt4****
LoadBalancerWeights	array	任意	バックエンドサーバーとしての ECS インスタンスまたは Elastic Container Instance の重み。このパラメーターを使用して、複数のインスタンスの重みを同時に指定できます。
	integer	任意	バックエンドサーバーとしての ECS インスタンスまたは Elastic Container Instance の重み。有効な値の範囲：1～100。説明このパラメーターは、サブスクリプションインスタンスとエコノミーモードのインスタンスには指定できません。デフォルト値： 50。	50
LifecycleHook	boolean	任意	この API を呼び出すときにスケールアウトのライフサイクルフックをトリガーするかどうかを指定します。有効な値： true false 説明このパラメーターは、サブスクリプションインスタンスとエコノミーモードのインスタンスには指定できません。デフォルト値： false。	false
RegionId	string	任意	スケーリンググループが属するリージョンの ID。	cn-qingdao
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、トークンはリクエスト間で一意である必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。詳細については、「べき等性の確保」をご参照ください。	123e4567-e89b-12d3-a456-42665544****
IgnoreInvalidInstance	boolean	任意	インスタンスのバッチをスケーリンググループに追加するときに、無効なインスタンスを無視するかどうかを指定します。有効な値： true：無効なインスタンスを無視します。無効なインスタンスが存在し、有効なインスタンスが追加された場合、対応するスケーリングアクティビティは警告状態になります。スケーリングアクティビティの詳細を確認して、無視された無効なインスタンスを表示できます。 false：無効なインスタンスを無視しません。スケーリンググループに追加するインスタンスのバッチに無効なインスタンスが存在する場合、エラーが返されます。デフォルト値： false。	false

レスポンスフィールド

フィールド	型	説明	例
	object
ScalingActivityId	string	スケーリングアクティビティの ID。	asa-bp1crxor24s28xf1****
RequestId	string	リクエストの ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

例

成功レスポンス

JSONJSON

{
  "ScalingActivityId": "asa-bp1crxor24s28xf1****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
500	InternalError	The request processing has failed due to some unknown error, exception or failure.

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

変更履歴

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