Adds one or more ApsaraDB RDS instances to a scaling group.
Operation description
Operation description
The following conditions must be met when you add ApsaraDB RDS instances to a scaling group:
-
The ApsaraDB RDS instances and the scaling group must belong to the same Alibaba Cloud account.
-
The ApsaraDB RDS instances must be in the unlocked state. For more information about the locking policy, see Usage notes for ApsaraDB RDS.
-
The ApsaraDB RDS instances must be in the running state.
-
If you add an ApsaraDB RDS instance that already exists in the scaling group to the scaling group again, the number of ApsaraDB RDS instances in the scaling group remains unchanged. However, the system attempts to add the private IP addresses of all ECS instances in the scaling group to the IP address whitelist of the ApsaraDB RDS instance.
After you add the ApsaraDB RDS instances, the default group in the IP address whitelist of the ApsaraDB RDS instances can contain a maximum of 1,000 IP addresses. For more information about IP address whitelists, see Configure an IP address whitelist.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ess:AttachDBInstances |
update |
*ScalingGroup
|
None | 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 address whitelist of the ApsaraDB RDS instances when the ApsaraDB RDS instances are added to the scaling group. Valid values:
Default value: false. |
false |
| ClientToken |
string |
No |
Ensures the idempotence of the request. You can generate the value on your client to ensure that the value is unique across different requests. The value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see Ensure idempotence. |
123e4567-e89b-12d3-a456-42665544**** |
| DBInstance |
array |
Yes |
The ID of ApsaraDB RDS instance N. Valid values of N: 1 to 5. |
rm-bp12cy3**** |
|
string |
No |
The ID of ApsaraDB RDS instance N. 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 association mode between the scaling group and the database. Valid values:
Default value: SecurityIp. |
SecurityIp |
| Type |
string |
No |
The database type. Valid values:
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.