Call the AttachDBInstances API to associate a database instance with a scaling group - Auto Scaling - Alibaba Cloud - Auto Scaling

Associates one or more ApsaraDB RDS instances with a scaling group.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ess:AttachDBInstances

update

*ScalingGroup

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

None

Request parameters

Parameter	Type	Required	Description	Example
ScalingGroupId	string	Yes	The ID of the scaling group.	asg-bp1avr6ensitts3w****
ForceAttach	boolean	No	Whether to add the private IP addresses of all ECS instances in the scaling group to the IP address whitelist of the ApsaraDB RDS instance. Valid values: true false Default value: false.	false
ClientToken	string	No	The client token that ensures the idempotence of the request. You can use the client to generate the token, but you must ensure that it is unique among requests. The token can only contain ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure the idempotence of a request.	123e4567-e89b-12d3-a456-42665544****
DBInstances	array	Yes	The IDs of the ApsaraDB RDS instances to attach to the scaling group.
	string	No	The ID of the ApsaraDB RDS instance to attach to the scaling group. Note You can attach up to five ApsaraDB RDS instances to a scaling group at the same time.	rm-bp12cy3****
RegionId	string	No	The region ID of the scaling group.	cn-qingdao
AttachMode	string	No	The mode in which to attach the database to the scaling group. Valid values: SecurityIp: adds the private IP addresses of scaled-out ECS instances to the IP address whitelist of the database. This mode is available only when the database is an ApsaraDB RDS instance. SecurityGroup: adds the security group of the scaling configuration used to create ECS instances in the scaling group to the security group whitelist of the database. Default value: SecurityIp.	SecurityIp
Type	string	No	The type of database to attach to the scaling group. Valid values: RDS Redis MongoDB Default value: RDS.	RDS

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.