实例批量变配
更新时间：2023-11-02
实例批量变配
接口描述
本接口适用于批量变配实例，目前支持批量变配一个主实例与多个只读实例。
本接口为V2接口。
注意事项
目前本接口不支持批量变配多个主实例的情况。
批量变配时，主实例存储大小应小于等于只读实例的存储大小。
请求结构
PUT /v{version}/instance/{instanceId}?resize HTTP/1.1
Host: rds.bj.baidubce.com
Content-Type: application/json;charset=UTF-8
Authorization: authorization string
{
"cpuCount": 4,
"memoryCapacity": 8,
"volumeCapacity": 300,
"isDirectPay": true,
"readReplicas": [
{
"instanceId": "rds-X4th0AQI",
"cpuCount": 2,
"memoryCapacity": 4,
"volumeCapacity": 500
}
]
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，此处值为2 |
| instanceId | String | 是 | URL参数 | 批量变配的主实例ID |
| cpuCount | Integer | 是 | RequestBody参数 | CPU核数，最小值是1 |
| memoryCapacity | Integer | 是 | RequestBody参数 | 内存大小，单位GB。最小值为1 |
| volumeCapacity | Integer | 是 | RequestBody参数 | 存储大小，单位GB。最小值为1，如果磁盘类型为diskIoType为cloud_enha，则volumeCapacity必须大于50 |
| readReplicas | List ReplicaRequest | 否 | RequestBody参数 | 批量变配时的只读实例数组，当参数isBatchResize = true 时此值无效，否则此值必填。 |
| isBatchResize | Boolean | 否 | RequestBody参数 | 取值为 true，代表开启一键批量变配功能，此时客户填写的只读信息（readReplicas）是无用的，会按照默认约定将需要升级的只读的存储大小与目标主实例存储大小保持一致；取值为 false 时，readReplicas值必填。 |
| isDirectPay | Boolean | 否 | RequestBody参数 | 是否进行直接支付，默认为否，设置为直接支付的变配订单会直接扣款，不需要在走支付逻辑 |
| isEnhanced | Boolean | 否 | RequestBody参数 | 是否为增强版RDS |
| effectiveTime | String | 否 | RequestBody参数 | 操作执行方式，有两种取值：timewindow、immediate。其中timewindow表示在时间窗口内执行，immediate表示立即执行。默认为immediate。实例默认的时间窗口为05:00~06:00，具体可参考实例详情内容 |
| masterAzone | String | 否 | RequestBody参数 | 变配时需要变更主库可用区，此参数需要传值，如：cn-bj-a。不传默认取当前主库az |
| backupAzone | String | 否 | RequestBody参数 | 变配时需要变更备库可用区，此参数需要传值，如：cn-bj-a。不传默认取当前备库az |
| diskIoType | String | 否 | RequestBody参数 | 存储磁盘包括本地SSD磁盘（取值为：normal_io）、增强型SSD云磁盘（取值为：cloud_enha）、 高性能云磁盘（取值为：cloud_high）、cloud_nor（取值为: 通用型SSD）四种，支持本地盘变更为增强型SSD云盘类型，即取消disable限制。反之，云盘不允许变更为本地盘。限制本地转云盘条件：1）当实例是应用是mysql且版本是5.5或5.6；2）参数是非本地SSD磁盘（normal_io）且此参数不为空字符 |
| subnetId | String | 否 | RequestBody参数 | 子网ID，默认为空 |
| edgeSubnetId | String | 否 | RequestBody参数 | 边缘子网ID |
| subnets | List SubnetMap | 否 | RequestBody参数 | 变配时如果主库或备库需要变更可用区，此参数需要传值 |
| couponId | List Long | 否 | RequestBody参数 | 批量变配时，API支付支持传入指定代金券ID，当主实例为预付费类型且想使用已有代金券支持时，此值必传。当前只支持传入一个值。 |
ReplicaRequest字段数据结构说明
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | RequestBody参数 | 批量变配的只读实例ID |
| cpuCount | Integer | 是 | RequestBody参数 | 只读实例CPU核数，最小值是1 |
| memoryCapacity | Integer | 是 | RequestBody参数 | 只读实例内存大小，单位GB。最小值为1 |
| volumeCapacity | Integer | 是 | RequestBody参数 | 只读实例存储大小，单位GB。最小值为1，如果磁盘类型为diskIoType为cloud_enha，则volumeCapacity必须大于50 |
| diskIoType | String | 否 | RequestBody参数 | 存储磁盘包括本地SSD磁盘（取值为：normal_io）、增强型SSD云磁盘（取值为：cloud_enha）、 高性能云磁盘（取值为：cloud_high）、cloud_nor（取值为: 通用型SSD）四种，支持本地盘变更为增强型SSD云盘类型，即取消disable限制。反之，云盘不允许变更为本地盘。限制本地转云盘条件：1）当实例是应用是mysql且版本是5.5或5.6；2）参数是非本地SSD磁盘（normal_io）且此参数不为空字符 |
SubnetMap字段数据结构说明
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| zoneName | String | 否 | RequestBody参数 | 可用区 |
| subnetId | Integer | 否 | RequestBody参数 | 子网ID |
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| orderList | List String | 批量变配的订单号数组 |
请求示例
PUT http://rds.bj.baidubce.com/v2/instance/rds-998pwfPX?resize
Host: rds.bj.baidubce.com
Content-Type: application/json;charset=UTF-8
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
"cpuCount": 4,
"memoryCapacity": 8,
"volumeCapacity": 550,
"isDirectPay": true,
"isBatchResize": true,
"couponId": [
231234
]
}响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:28:11 GMT
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
Server: BWS
[
"224eafdc43fc4d5f9c4357b2d2ae06dc",
"6a42f955ca9343e1b8ca42b65ae16655"
]