Associates one or more ApsaraDB RDS instances with a scaling group.
Operation description
Before you associate an ApsaraDB RDS instance with a scaling group, make sure that the ApsaraDB RDS instance meets the following requirements:
- The ApsaraDB RDS instance and the scaling group must belong to the same Alibaba Cloud account.
- The ApsaraDB RDS instance must be unlocked. For more information about the lock policy, see ApsaraDB RDS usage notes.
- The ApsaraDB RDS instance must be in the Running state.
After an ApsaraDB RDS instance is associated with the scaling group, the default IP address whitelist of the ApsaraDB RDS instance can contain no more than 1,000 IP addresses. For more information, see Set the whitelist.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ess:AttachDBInstances | update |
|
| 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 scaling group to the IP address whitelist of the ApsaraDB RDS instance. Valid values:
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 value, but you must ensure that the value is unique among different 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 ID of the ApsaraDB RDS instance. | |
| string | Yes | The ID of the ApsaraDB RDS instance. | rm-bp12cy3**** | |
| RegionId | string | No | The region ID of the scaling group. | cn-qingdao |
| AttachMode | string | No | The mode in which you want to attach the ApsaraDB RDS instance to the scaling group. Valid values:
| SecurityIp |
| Type | string | No | The type of the database that you want to attach to the scaling group. Valid values:
Default value: RDS. | RDS |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-04-23 | The request parameters of the API has changed | View Change Details |