All Products
Search
Document Center

Auto Scaling:AttachDBInstances

Last Updated:Jun 06, 2024

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ScalingGroupIdstringYes

The ID of the scaling group.

asg-bp1avr6ensitts3w****
ForceAttachbooleanNo

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:

  • true
  • false

Default value: false.

false
ClientTokenstringNo

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****
DBInstancesarrayYes

The ID of the ApsaraDB RDS instance.

stringYes

The ID of the ApsaraDB RDS instance.

rm-bp12cy3****
RegionIdstringNo

The region ID of the scaling group.

cn-qingdao
AttachModestringNo

The mode in which you want to attach the ApsaraDB RDS instance to the scaling group. Valid values:

  • SecurityIp: the SecurityIp mode. Auto Scaling automatically adds the private IP addresses of the scaled out instances to the IP address whitelist of the ApsaraDB RDS instance. You can select this mode only when you attach an ApsaraDB RDS instance to a scaling group.
  • SecurityGroup: the security group mode. Auto Scaling adds the security group of the scaling configuration to the security group whitelist for registration and association.
SecurityIp
TypestringNo

The type of the database that you want to attach to the scaling group. Valid values:

  • ApsaraDB RDS
  • ApsaraDB for Redis
  • ApsaraDB for MongoDB

Default value: RDS.

RDS

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

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 timeSummary of changesOperation
2024-04-23The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: AttachMode
    Added Input Parameters: Type