文档

AttachDBInstances - 添加一个或多个RDS实例

通过调用API AttachDBInstances为伸缩组添加一个或多个RDS实例,可实现根据您的需要随时调整伸缩组内的RDS实例数量,增加您使用上的灵活性与实用性。

接口说明

向伸缩组添加 RDS 实例时需要满足以下条件:

  • RDS 实例与伸缩组必须属于同一账号。

  • RDS 实例必须处于未锁定状态,关于锁定策略,请参见 RDS 使用须知

  • RDS 实例必须处于运行中状态。

  • RDS 实例必须是您当前账户所拥有的,并且该实例未被删除。

  • 如果将伸缩组中已存在的 RDS 实例再次添加到伸缩组,则伸缩组内的 RDS 实例数量不会改变,但系统会尝试把当前伸缩组内的 ECS 实例私网 IP 全部加入到 RDS 实例的 IP 白名单中。

说明 添加 RDS 实例后,RDS IP 白名单的 default 分组中包含的 IP 不能超过 1000 条。关于 IP 白名单,请参见设置白名单

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ScalingGroupIdstring

伸缩组的 ID。

asg-bp1avr6ensitts3w****
ForceAttachboolean

当 RDS 实例添加到伸缩组时,是否把当前伸缩组内实例的私网 IP 全部添加到 RDS 实例 IP 白名单中。取值范围:

  • true:添加。

  • false:不添加。

默认值:false。

false
ClientTokenstring

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。

只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性

123e4567-e89b-12d3-a456-42665544****
DBInstancesarray

RDS 实例的 ID。

string

RDS 实例的 ID。

说明 支持最多一次添加 5 个 RDS 实例到伸缩组。
rm-bp12cy3****
RegionIdstring

伸缩组所属的地域 ID。

cn-qingdao
AttachModestring

伸缩组与数据库关联方式。取值范围:

  • SecurityIp:修改 SecurityIp(即数据库的 IP 白名单)模式,通过将扩容实例自动添加到数据库白名单(目前仅 RDS 数据库支持)。
  • SecurityGroup:安全组模式,通过将伸缩配置安全组添加至数据库安全组白名单关联注册。
SecurityIp
Typestring

数据库类型。取值范围:

  • RDS。
  • Redis。
  • MongoDB。

默认值:RDS。

RDS

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-04-23OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:AttachMode
    新增入参:Type