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

1 つ以上の ApsaraDB RDS インスタンスをスケーリンググループにアタッチします。

今すぐお試しください

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

update

*ScalingGroup

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ScalingGroupId	string	必須	スケーリンググループの ID。	asg-bp1avr6ensitts3w****
ForceAttach	boolean	任意	この操作を実行する際に、スケーリンググループに現在存在するすべての ECS インスタンスのプライベート IP アドレスを、ApsaraDB RDS インスタンスの IP アドレスホワイトリストに追加するかどうかを指定します。有効値： true false デフォルト値： false。	false
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークンです。クライアントを使用して値を生成できますが、異なるリクエスト間で値がユニークである必要があります。トークンには ASCII 文字のみ使用でき、長さは 64 文字以内である必要があります。詳細については、「リクエストのべき等性を保証する方法」をご参照ください。	123e4567-e89b-12d3-a456-42665544****
DBInstances	array	必須	スケーリンググループにアタッチする ApsaraDB RDS インスタンスの ID の配列。
	string	任意	スケーリンググループにアタッチする ApsaraDB RDS インスタンスの ID。説明一度に最大 5 つの ApsaraDB RDS インスタンスをスケーリンググループにアタッチできます。	rm-bp12cy3****
RegionId	string	任意	スケーリンググループが属するリージョンの ID。	cn-qingdao
AttachMode	string	任意	データベースをスケーリンググループにアタッチする際のモードです。有効値： SecurityIp：今後スケールアウトによって追加される ECS インスタンスのプライベート IP アドレスをデータベースの IP アドレスホワイトリストに追加します。このモードは、アタッチするデータベースが ApsaraDB RDS インスタンスの場合にのみ選択できます。 SecurityGroup：スケーリンググループで ECS インスタンスを作成する際に使用されるスケーリング設定のセキュリティグループを、データベースのセキュリティグループホワイトリストに登録します。デフォルト値： SecurityIp。	SecurityIp
Type	string	任意	スケーリンググループにアタッチするデータベースのタイプです。有効値： RDS Redis MongoDB デフォルト値： RDS。	RDS

レスポンスフィールド

フィールド	型	説明	例
	object	ルートオブジェクト。
RequestId	string	リクエストの ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

例

成功レスポンス

JSONJSON

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

エラーコード

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

変更履歴

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