通过调用API AttachDBInstances为伸缩组添加一个或多个RDS实例,可实现根据您的需要随时调整伸缩组内的RDS实例数量,增加您使用上的灵活性与实用性。
接口说明
向伸缩组添加 RDS 实例时需要满足以下条件:
-
RDS 实例与伸缩组必须属于同一账号。
-
RDS 实例必须处于未锁定状态,关于锁定策略,请参见 RDS 使用须知。
-
RDS 实例必须处于运行中状态。
-
RDS 实例必须是您当前账户所拥有的,并且该实例未被删除。
-
如果将伸缩组中已存在的 RDS 实例再次添加到伸缩组,则伸缩组内的 RDS 实例数量不会改变,但系统会尝试把当前伸缩组内的 ECS 实例私网 IP 全部加入到 RDS 实例的 IP 白名单中。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ess:AttachDBInstances | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ScalingGroupId | string | 是 | 伸缩组的 ID。 | asg-bp1avr6ensitts3w**** |
ForceAttach | boolean | 否 | 当 RDS 实例添加到伸缩组时,是否把当前伸缩组内实例的私网 IP 全部添加到 RDS 实例 IP 白名单中。取值范围:
默认值:false。 | false |
ClientToken | string | 否 | 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性。 | 123e4567-e89b-12d3-a456-42665544**** |
DBInstances | array | 是 | RDS 实例的 ID。 | |
string | 是 | RDS 实例的 ID。 说明
支持最多一次添加 5 个 RDS 实例到伸缩组。
| rm-bp12cy3**** | |
RegionId | string | 否 | 伸缩组所属的地域 ID。 | cn-qingdao |
AttachMode | string | 否 | 伸缩组与数据库关联方式。取值范围:
默认值:SecurityIp。 | SecurityIp |
Type | string | 否 | 数据库类型。取值范围:
默认值:RDS。 | RDS |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-04-23 | OpenAPI 入参发生变更 | 查看变更详情 |