AttachDBInstances - Auto Scaling - Alibaba Cloud Documentation Center

Operation description

The following conditions must be met when you add ApsaraDB RDS instances to a scaling group:

The RDS instances and the scaling group must belong to the same Alibaba Cloud account.
The RDS instances must be in an unlocked state. For more information about the lock policy, refer to Chinese documentation.
The RDS instances must be in the Running state.
If you add an RDS instance that already exists in the scaling group, the number of RDS instances in the scaling group does not change. However, the system attempts to add the private IP addresses of all ECS instances in the scaling group to the IP whitelist of the RDS instance.

Note

After you add an RDS instance, the default group of the RDS IP whitelist can contain a maximum of 1,000 IP addresses. For more information about IP whitelists, refer to Set a whitelist.

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	Specifies whether to add the private IP addresses of all instances in the current scaling group to the IP whitelist of the RDS instance when the RDS instance is added to the scaling group. Valid values: true: Adds the private IP addresses. false: Does not add the private IP addresses. Default value: false.	false
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, refer to How to ensure idempotence.	123e4567-e89b-12d3-a456-42665544****
DBInstance	array	Yes	The ID of the RDS instance. Valid values of N: 1 to 5.	rm-bp12cy3****
	string	No	The ID of the RDS instance. Valid values of N: 1 to 5.	rm-bp12cy3****
RegionId	string	No	The region ID of the scaling group.	cn-qingdao
AttachMode	string	No	The mode in which the scaling group is associated with the database. Valid values: SecurityIp: IP whitelist mode. The system automatically adds the private IP addresses of scaled-out instances to the IP whitelist of the database. Currently, only ApsaraDB RDS databases are supported. SecurityGroup: security group mode. The system adds the security group specified in the scaling configuration to the security group whitelist of the database, which allows instances in the security group to access the database. Default value: SecurityIp.	SecurityIp
Type	string	No	The type of the database. Valid values: RDS Redis MongoDB Default value: RDS.	RDS

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	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.