批量变更实例规格 - BatchResizeFlavor
调试
您可以在API Explorer中调试该接口。
接口约束
- 该接口仅支持RDS for MySQL数据库引擎。
- 该接口一分钟限制调用次数为10次。
- 原实例需满足以下限制:
- 原实例计费模式相同,同为按需计费或包周期计费。
- 原实例规格类型相同。
- 原实例磁盘类型相同。
- 原实例所在可用区相同。如果原实例是主备实例,可用区顺序不作约束。
- 原实例不为本地盘实例。
- 原实例企业项目相同。
- 原实例未开启规格自动变配功能。
授权信息
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| rds:instance:modifySpec | write | - | - rds:FlavorType | - | - |
URI
- 参数说明
表1 参数说明 参数
是否必选
参数类型
描述
project_id
是
String
参数解释:
租户在某一region下的project ID。
获取方法请参见获取项目ID。
约束限制:
不涉及。
取值范围:
不涉及。
默认取值:
不涉及。
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| instance_ids | 是 | Array of strings | 参数解释: 实例ID列表。 约束限制: 一次最多下发10个实例。 取值范围: 多个实例ID用逗号隔开,示例: ["347288b745f9455faa700e88c17ca276in01", "161ddefa425441289661354f0c370c9din01"] 默认取值: 不涉及。 |
| spec_code | 是 | String | 参数解释: 资源规格编码。 可调用查询数据库可变更规格接口,通过表4中的“code”获取。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| delay | 否 | Boolean | 参数解释: 是否进行定时规格变更。 约束限制: 不涉及。 取值范围:
默认取值: false |
| auto_pay | 否 | Boolean | 参数解释: 变更包周期实例的规格时可指定,表示是否自动从客户的账户中支付。 约束限制: 包周期实例降配时自动退费,该参数无效。 取值范围:
默认取值: false |
| occupy_ip | 否 | Boolean | 参数解释: 表示是否占用IP进行规格变更。 约束限制: 该参数为false时,会导致单机实例变更中断时长为分钟级。 取值范围:
默认取值: true |
请求示例
批量变更实例规格。
POST https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/batch/resize
{
"instance_ids": ["347288b745f9455faa700e88c17ca276in01", "161ddefa425441289661354f0c370c9din01"],
"spec_code": "rds.mysql.n1.large.2",
"delay": false,
"auto_pay": false,
"occupy_ip": true
} 响应消息
- 按需实例
- 正常响应要素说明
表3 要素说明 名称
参数类型
说明
job_id
String
参数解释:
任务ID。该任务ID不会显示在RDS任务中心界面,请前往任务中心界面查看所选实例是否处于规格变更状态中。
取值范围:
不涉及。
- 正常响应样例
{ "job_id": "2b414788a6004883a02390e2eb0ea227" } - 异常响应
请参见异常响应结果。
- 正常响应要素说明
- 包周期实例
- 正常响应要素说明
表4 要素说明 名称
参数类型
说明
order_id
String
参数解释:
订单ID。
取值范围:
不涉及。
- 正常响应样例
{ "order_id": "CS2009151216NO2U1" } - 异常响应
请参见异常响应结果。
- 正常响应要素说明
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。