实例管理接口说明
更新时间：2025-08-22
创建主实例
前提条件
创建实例需要实名认证，没有通过实名认证的可以前往百度智能云官网控制台中的安全认证下的实名认证中进行认证。
说明
- 本接口用于创建一个或多个相同配置的云数据库 RDS 实例。
- 创建计费方式为后付费的实例需要账户现金余额+通用代金券大于100；预付费方式的实例则需要账户现金余额大于等于实例费用。
- 支持批量创建，且如果创建过程中有一个实例创建失败，所有实例将全部回滚，均创建失败。
- 创建接口为异步创建，可通过查询指定实例详情接口查询实例状态。
请求结构
Plain Text
1POST /v{version}/instance?clientToken={clientToken} HTTP/1.1
2HOST: rds.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "billing":{
7 "paymentTiming": paymentTiming,
8 "reservation": {
9 "reservationLength": reservationLength
10 }
11 },
12 "purchaseCount" : purchaseCount,
13 "instanceName" : instanceName,
14 "engine" : engine,
15 "engineVersion" : engineVersion,
16 "cpuCount":cpuCount,
17 "memoryCapacity" : memoryCapacity,
18 "volumeCapacity" : volumeCapacity,
19 "zoneNames":[zoneName],
20 "vpcId": vpcId ,
21 "isDirectPay": isDirectPay,
22 "subnets":[
23 {
24 "zoneName": zoneName,
25 "subnetId": subnetId
26 }
27 ],
28 "tags": [
29 {
30 "tagKey": tagKey,
31 "tagValue": tagValue
32 }
33 ]
34}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | string | 是 | URL参数 | API 版本号 |
| clientToken | string | 是 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串。 |
| billing | billing | 是 | RequestBody参数 | 计费相关参数。结构及取值参考 |
| purchaseCount | int | 否 | RequestBody参数 | 批量创建云数据库 RDS 实例个数, 最大不超过10；默认1 |
| instanceName | string | 否 | RequestBody参数 | 1）用户自定义实例名；2）允许小写字母、数字；3）长度限制为1~64；4) 默认命名规则:{engine} + {engineVersion}。 |
| engine | string | 是 | RequestBody参数 | 数据库引擎。MySQL；SQLServer；PostgreSQL。详情参考 |
| engineVersion | string | 是 | RequestBody参数 | 数据库版本，MySQL：5.5/5.6/5.7；SQLServer：2008r2/2012sp3/2016sp1；PostgreSQL：9.4 |
| category | string | 否 | RequestBody参数 | 所属系列。Basic：单机基础版，Standard：双机高可用版。仅SQLServer 2012sp3 支持单机基础版。默认Standard。详情参考 |
| cpuCount | int | 是 | RequestBody参数 | CPU核数。取值参考 |
| memoryCapacity | int | 是 | RequestBody参数 | 套餐内存大小，单位GB。取值参考 |
| volumeCapacity | int | 是 | RequestBody参数 | 套餐磁盘大小，单位GB。每5G递增。范围参考 |
| zoneNames | List String | 否 | RequestBody参数 | 指定zone信息，默认为空，由系统自动选择，可通过调用查询可用区列表接口查询可用区列表。zoneName命名规范是小写的“国家-region-可用区序列"，例如北京可用区A为"cn-bj-a"。 |
| vpcId | string | 否 | RequestBody参数 | vpc，如果不提供则属于默认vpc。可通过调用 查询VPC列表接口查询可用的VPC |
| isDirectPay | Boolean | 否 | RequestBody参数 | 是否进行直接支付，默认false，设置为直接支付的变配订单会直接扣款，不需要在走支付逻辑 |
| subnets | List SubnetMap | 否 | RequestBody参数 | vpc内，每个可用区的subnetId；如果不是默认vpc则必须指定 subnetId。可通过调用查询子网列表接口查询子网列表。 |
| tags | List Tag | 否 | RequestBody参数 | 实例绑定的标签信息 |
SubnetMap
| 参数名称 | 类型 | 描述 |
|---|---|---|
| zoneName | String | 可用区 |
| subnetId | String | 子网 Id |
Tag
| 参数名称 | 类型 | 描述 |
|---|---|---|
| tagKey | String | 标签key |
| tagValue | String | 标签value |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| instanceIds | List InstanceId | 由InstanceId组成的数组 |
请求示例
Plain Text
1POST /v1/instance?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2HOST: rds.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7 "billing":{
8 "paymentTiming":"Prepaid",
9 "reservation": {
10 "reservationLength": 1
11 }
12 },
13 "purchaseCount":1,
14 "instanceName":"name-01",
15 "engine":"mysql",
16 "engineVersion":"5.6",
17 "cpuCount":1,
18 "memoryCapacity":0.25,
19 "volumeCapacity":5,
20 "zoneNames":["cn-bj-a"],
21 "vpcId": "vpc-IyrqYIQ7",
22 "isDirectPay": isDirectPay,
23 "subnets":[
24 {
25 "zoneName": "cn-bj-a",
26 "subnetId": "sbn-IyWRnII7"
27 }
28 ],
29 "tags": [
30 {
31 "tagKey": "goods_type",
32 "tagValue": "music"
33 }
34 ]
35}返回示例
Plain Text
1{
2 "instanceIds":["rds-sgrw14145"]
3}创建只读实例
前提条件
需要在云数据库 RDS 主实例的基础上进行创建。
说明
- 仅数据库类型为 MySQL 的主实例支持创建只读实例
- 只读实例的数据库引擎和数据库版本与主实例相同，无需设置，主实例版本最低是 MySQL 5.6
- 只读实例的磁盘容量不能小于主实例的磁盘容量
- 只读实例的 vpcId 需跟主实例一致
- 一个云数据库 RDS 实例，最多只能有 5 个只读实例，且一次只能创建一个
- 只读实例只支持后付费方式购买
请求结构
Plain Text
1POST /v{version}/instance?readReplica&clientToken={clientToken} HTTP/1.1
2HOST: rds.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "billing":{
7 "paymentTiming": paymentTiming,
8 "reservation": {
9 "reservationLength": reservationLength
10 }
11 },
12 "sourceInstanceId" : sourceInstanceId,
13 "instanceName" : instanceName,
14 "cpuCount":cpuCount,
15 "memoryCapacity" : memoryCapacity,
16 "volumeCapacity" : volumeCapacity,
17 "zoneNames":[zoneName],
18 "vpcId": vpcId ,
19 "isDirectPay": isDirectPay,
20 "subnets":[
21 {
22 "zoneName": zoneName,
23 "subnetId": subnetId
24 }
25 ],
26 "tags": [
27 {
28 "tagKey": tagKey,
29 "tagValue": tagValue
30 }
31 ]
32}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | string | 是 | URL参数 | API 版本号 |
| clientToken | string | 是 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串。 |
| billing | billing | 否 | RequestBody参数 | 计费相关参数。只读实例只支持后付费Postpaid。结构及取值参考 |
| purchaseCount | int | 否 | RequestBody参数 | 批量创建云数据库 RDS 只读实例个数, 目前只支持一次创建一个. |
| sourceInstanceId | string | 是 | RequestBody参数 | 主实例ID |
| instanceName | string | 否 | RequestBody参数 | 用户自定义实例名，要求：1）允许小写字母、数字；2）长度限制为1~32；默认{engine} + {engineVersion} |
| cpuCount | int | 是 | RequestBody参数 | CPU核数。取值参考 |
| memoryCapacity | int | 是 | RequestBody参数 | 套餐内存大小，单位GB。取值参考 |
| volumeCapacity | int | 是 | RequestBody参数 | 套餐磁盘大小，单位GB，每5GB递增。不能小于主实例磁盘。范围参考 |
| zoneNames | string | 否 | RequestBody参数 | 指定zone信息，默认为空，由系统自动选择，可通过调用查询可用区列表接口查询可用区列表。zoneName命名规范是小写的“国家-region-可用区序列"，例如北京可用区A为"cn-bj-a"。只读实例只能在单可用区中，故此处只能填写一个可用区。 |
| vpcId | string | 否 | RequestBody参数 | 与主实例 vpcId 相同 |
| isDirectPay | Boolean | 否 | RequestBody参数 | 是否进行直接支付，默认false，设置为直接支付的变配订单会直接扣款，不需要在走支付逻辑 |
| subnets | ListSubnetMap | 否 | RequestBody参数 | 特定vpc内，可用区的 subnetId；如果指定的 vpcId为自定义vpc，则必须指定 subnetId。可通过调用查询子网列表接口查询子网列表。只读实例只能在单可用区中，故此处只能填写一个 SubnetMap。 |
| tags | List Tag | 否 | RequestBody参数 | 实例绑定的标签信息 |
SubnetMap
| 参数名称 | 类型 | 描述 |
|---|---|---|
| zoneName | String | 可用区 |
| subnetId | String | 子网Id |
Tag
| 参数名称 | 类型 | 描述 |
|---|---|---|
| tagKey | String | 标签key |
| tagValue | String | 标签value |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| instanceIds | List InstanceId | 由InstanceId组成的数组 |
请求示例
Plain Text
1POST /v1/instance?readReplica&clientToken={be31b98c-5e41-4838-9830-9be700de5a20} HTTP/1.1
2HOST: rds.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7 "billing":{
8 "paymentTiming":"Postpaid"
9 },
10 "purchaseCount":1,
11 "instanceName":"mysql56",
12 "sourceInstanceId": "rds-mudjimy0jbig",
13 "cpuCount":1,
14 "memoryCapacity":0.25,
15 "volumeCapacity":5,
16 "zoneNames":["cn-bj-a"],
17 "vpcId": "vpc-IyrqYIQ7",
18 "subnets":[
19 {
20 "zoneName": "cn-bj-a",
21 "subnetId": "sbn-IyWRnII7"
22 }
23 ],
24 "tags": [
25 {
26 "tagKey": "goods_type",
27 "tagValue": "music"
28 }
29 ]
30}返回示例
Plain Text
1{
2 "instanceIds":["rds-cwerfq23f"]
3}创建代理实例
前提条件
需要在云数据库 RDS 主实例的基础上进行创建。
说明
- 仅数据库类型为MySQL的主实例支持创建只读实例
- 代理实例套餐和主实例套餐绑定，主实例版本最低是MySQL 5.6
- 每个主实例最多可以创建1个代理实例
- 只支持后付费
- 需与主实例在同一vpc中
请求结构
Plain Text
1POST /v{version}/instance?rdsproxy&clientToken={clientToken} HTTP/1.1
2HOST: rds.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "billing":{
7 "paymentTiming": paymentTiming,
8 "reservation": {
9 "reservationLength": reservationLength
10 }
11 },
12 "sourceInstanceId" : sourceInstanceId,
13 "instanceName" : instanceName,
14 "nodeAmount":nodeAmount,
15 "zoneNames":[zoneName],
16 "vpcId": vpcId ,
17 "subnets":[
18 {
19 "zoneName": zoneName,
20 "subnetId": subnetId
21 }
22 ],
23 "tags": [
24 {
25 "tagKey": tagKey,
26 "tagValue": tagValue
27 }
28 ]
29}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | string | 是 | URL参数 | API 版本号 |
| clientToken | string | 是 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串。 |
| billing | billing | 否 | RequestBody参数 | 计费相关参数。代理实例只支持后付费Postpaid。结构及取值参考 |
| sourceInstanceId | string | 是 | RequestBody参数 | 主实例ID |
| instanceName | string | 否 | RequestBody参数 | 用户自定义实例名，要求：1）允许小写字母、数字；2）长度限制为1~32；默认为rdsproxy |
| nodeAmount | int | 是 | RequestBody参数 | 代理实例节点数。取值范围2，4，6，8，16。 |
| zoneNames | string | 否 | RequestBody参数 | 指定zone信息，默认为空，由系统自动选择，可通过调用查询可用区列表接口查询可用区列表。zoneName命名规范是小写的“国家-region-可用区序列"，例如北京可用区A为"cn-bj-a"。建议与主实例的可用区保持一致。 |
| vpcId | string | 否 | RequestBody参数 | 与主实例vpcId相同 |
| isDirectPay | Boolean | 否 | RequestBody参数 | 是否进行直接支付，默认false，设置为直接支付的变配订单会直接扣款，不需要在走支付逻辑 |
| subnets | List SubnetMap | 否 | RequestBody参数 | 特定vpc内，可用区的subnetId；如果指定的vpcId为自定义vpc，则必须指定subnetId。可通过调用查询子网列表接口查询子网列表。建议与主实例的子网保持一致。 |
| tags | List Tag | 否 | RequestBody参数 | 实例绑定的标签信息 |
SubnetMap
| 参数名称 | 类型 | 描述 |
|---|---|---|
| zoneName | String | 可用区 |
| subnetId | String | 子网Id |
Tag
| 参数名称 | 类型 | 描述 |
|---|---|---|
| tagKey | String | 标签key |
| tagValue | String | 标签value |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| instanceIds | List InstanceId | 由InstanceId组成的数组 |
请求示例
Plain Text
1POST /v1/instance?rdsproxy&clientToken={be31b98c-5e41-4838-9830-9be700de5a20} HTTP/1.1
2HOST: rds.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7 "billing":{
8 "paymentTiming":"Postpaid"
9 },
10 "instanceName":"mysql56",
11 "sourceInstanceId": "rds-mudjimy0jbig",
12 "nodeAmount":2,
13 "zoneNames":["cn-bj-a"],
14 "vpcId": "vpc-IyrqYIQ7",
15 "subnets":[
16 {
17 "zoneName": "cn-bj-a",
18 "subnetId": "sbn-IyWRnII7"
19 }
20 ],
21 "tags": [
22 {
23 "tagKey": "goods_type",
24 "tagValue": "music"
25 }
26 ]
27}返回示例
Plain Text
1{
2 "instanceIds":["rds-mj7c09d7ck0q"]
3}查询实例列表
说明
- 只能查看属于自己账号的实例列表
- 接口将每个主实例和其只读、代理实例分成一组，参数maxKeys代表分组数，也就是主实例的个数
请求结构
Plain Text
1GET /v{version}/instance HTTP/1.1
2HOST: rds.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | string | 是 | URL参数 | API 版本号 |
| marker | string | 否 | Query参数 | 批量获取列表的查询的起始位置，是一个由系统生成的字符串 |
| maxKeys | int | 否 | Query参数 | 每页包含的最大数量(主实例)，最大数量通常不超过1000，缺省值为1000 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| marker | String | 批量获取列表的查询的起始位置，是一个由系统生成的字符串 |
| maxKeys | int | 每页包含的最大数量，最大数量通常不超过1000，缺省值为1000。 |
| isTruncated | boolean | true表示后面还有数据，false表示已经是最后一页 |
| nextMarker | String | 获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现 |
| instances | List Instance | 由Instance对象组成的数组 |
请求示例
Plain Text
1GET /v1/instance?marker=r-IyWRtII7&maxKeys=1 HTTP/1.1
2HOST: rds.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
Plain Text
1{
2 "nextMarker": "rds-xktdeMSf",
3 "marker": "rds-IyWRtII7",
4 "maxKeys": 1,
5 "isTruncated": true,
6 "instances":[{
7 "instanceId" : "rds-IyWRtII7",
8 "instanceName" : "mysql5145",
9 "engine" : "mysql",
10 "engineVersion" : "5.6",
11 "volumeCapacity" : 5,
12 "memoryCapacity" : 0.25,
13 "usedStorage" : 1.24,
14 "instanceStatus" : "Creating",
15 "instanceCreateTime" : "2016-06-01T12:00:00Z",
16 "instanceExpireTime" : "2016-07-01T12:00:00Z",
17 "instanceType" : "Master",
18 "zoneNames" :["cn-bj-a"],
19 "paymentTiming" : "Prepaid"
20 }]
21}查询指定实例详情
说明
- 查询指定实例的详细信息
请求结构
Plain Text
1GET /v{version}/instance/{instanceId} HTTP/1.1
2HOST: rds.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | string | 是 | URL参数 | API 版本号 |
| instanceId | string | 是 | URL参数 | 指定实例Id |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| instanceId | String | 实例ID |
| instanceName | String | 数据库实例名 |
| engine | String | 数据库引擎,参见引擎类型 |
| engineVersion | String | 数据库引擎版本,取值参考数据库版本 |
| category | String | 所属系列。Basic：单机基础版，Standard：双机高可用版 |
| instanceStatus | String | 实例状态，参见实例状态表 |
| cpuCount | Int | CPU核数 |
| memoryCapacity | Int | 实例内存，单位GB |
| volumeCapacity | Int | 存储空间，单位GB |
| nodeAmount | Int | 节点数（代理实例） |
| usedStorage | Int | 已用存储空间，单位GB |
| instanceCreateTime | Datetime | 实例创建时间，规范参考时间与日期 |
| instanceExpireTime | Datetime | 实例到期时间，规范参考时间与日期 |
| endpoint | Endpoint | 数据库连接信息 |
| publicAccessStatus | String | 外网访问功能状态,参考公网状态表 |
| syncMode | String | 数据同步方式,参考同步方式 |
| backupPolicy | BackupPolicy | 备份策略 |
| region | String | 该实例的区域 |
| instanceType | String | 实例类型，参考实例类型 |
| sourceInstanceId | String | 主实例ID，如果为主实例则为空 |
| sourceRegion | String | 该实例的主实例的区域 |
| zoneNames | List String | 实例的可用区 |
| vpcId | String | 实例所属VPC的ID |
| subnets | List Subnet | 实例所在子网 |
| topology | Topology | 实例所属数据库集群的拓扑信息 |
| paymentTiming | String | 付费方式,参考付费方式 |
请求示例
Plain Text
1GET /v1/instance/rds-nca3jn5j HTTP/1.1
2HOST: rds.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
3Content-Type: application/json
4{
5 "instanceId": "rds-mut9rhom8p3m",
6 "instanceName": "mysql56",
7 "memoryCapacity": 0.25,
8 "volumeCapacity": 5,
9 "nodeAmount": 2,
10 "usedStorage": 0.5672,
11 "engine": "mysql",
12 "engineVersion": "5.6",
13 "instanceStatus": "Available",
14 "publicAccessStatus": "Closed",
15 "instanceCreateTime": "2016-04-26T06:46:30Z",
16 "instanceExpireTime": "2016-05-26T06:46:11Z",
17 "endpoint": {
18 "address": "mysql.rdsmut9rhom8p3m.bj.bce.qa.sandbox.baidu.com",
19 "port": 3306,
20 "vnetIp": "192.168.0.1",
21 "inetIp": "180.32.96.1"
22 },
23 "instanceType": "Master",
24 "zoneNames": ["cn-bj-a"],
25 "vpcId": "v-kj3nc8fs",
26 "backupPolicy": {
27 "backupDays": "0,1,2,3,4,5,6",
28 "backupTime": "17:00:00Z",
29 "persistent": false,
30 "expireInDays": 0,
31 "freeSpace": 5
32 },
33 "topology": {
34 "rdsproxy": [],
35 "master": [
36 "rds-mut9rhog"
37 ],
38 "readReplica": [
39 "rds-m2s2du6j",
40 "rds-m4bkxb0i"
41 ]
42 }
43 "syncMode" : "Async",
44 "paymentTiming" : "Prepaid"
45}删除实例
释放单个云数据库 RDS 实例，释放后实例所使用的物理资源都被收回，相关数据全部丢失且不可恢复。
说明
- 只有付费类型为Postpaid或者付费类型为Prepaid且已过期的实例才可以释放。
- 如果主实例被释放，那么和主实例关联的只读实例和代理实例也会被释放。
请求结构
Plain Text
1DELETE /v{version}/instance?instanceIds={instanceId} HTTP/1.1
2HOST: rds.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | string | 是 | URL参数 | API 版本号 |
| instanceIds | String | 是 | Query参数 | 实例Id,多个实例间用英文半角逗号","隔开，最多可输入10个。 |
返回头域
除公共头域，无其它特殊头域。
返回参数
无特殊返回参数。
请求示例
Plain Text
1DELETE /v1/instance?instanceIds=r-cda3fcc8,r-mje3njde HTTP/1.1
2HOST: rds.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
3Content-Type: application/json
4Content-Length: 0重启实例
请求结构
Plain Text
1PUT /v{version}/instance/{instanceId}?reboot HTTP/1.1
2HOST: rds.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | string | 是 | URL参数 | API 版本号 |
| instanceId | string | 是 | URL参数 | 指定实例Id |
返回头域
除公共头域，无其它特殊头域。
返回参数
无特殊返回参数
请求示例
Plain Text
1PUT /v1/instance/r-m1x9dhwe?reboot HTTP/1.1
2HOST: rds.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
3Content-Type: application/json
4Content-Length: 0修改实例名字
请求结构
Plain Text
1PUT /v{version}/instance/{instanceId}?rename HTTP/1.1
2HOST: rds.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "instanceName":"instanceName"
7}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | string | 是 | URL参数 | API 版本号 |
| instanceId | string | 是 | URL参数 | 指定实例Id |
| instanceName | string | 是 | RequestBody参数 | 支持大小写字母、数字以及-_ /.等特殊字符，必须以字母开头，长度1-64。 |
返回头域
除公共头域，无其它特殊头域。
返回参数
无特殊返回参数。
请求示例
Plain Text
1PUT /v1/instance/r-mkd4j3ns?rename HTTP/1.1
2HOST: rds.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7 "instanceName":"mysql55"
8}返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
3Content-Type: application/json
4Content-Length: 0修改同步模式
请求结构
Plain Text
1PUT /v{version}/instance/{instanceId}?modifySyncMode HTTP/1.1
2HOST: rds.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "syncMode":"syncMode"
7}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | string | 是 | URL参数 | API 版本号 |
| instanceId | string | 是 | URL参数 | 指定实例Id |
| syncMode | string | 是 | RequestBody参数 | 取值参考同步模式 |
返回头域
除公共头域，无其它特殊头域。
返回参数
无特殊返回参数
请求示例
Plain Text
1PUT /v1/instance/r-midne4nf?syncMode HTTP/1.1
2HOST: rds.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7 "syncMode":"Async"
8}返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
3Content-Type: application/json
4Content-Length: 0修改连接信息
说明
- 目前只能修改域名前缀
请求结构
Plain Text
1PUT /v{version}/instance/{instanceId}?modifyEndpoint HTTP/1.1
2HOST: rds.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "address" : "address"
7}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API 版本号 |
| instanceId | String | 是 | URL参数 | 指定实例Id |
| address | String | 是 | RequestBody参数 | 只传输域名前缀即可。域名前缀由小写字母和数字组成，以小写字母开头，长度在3-30之间。 |
返回头域
除公共头域，无其它特殊头域。
返回参数
无特殊返回参数
请求示例
Plain Text
1PUT /v1/instance/r-mmcjd3hf?modifyEndpoint HTTP/1.1
2HOST: rds.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7 "address" : "mysql55"
8}返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
3Content-Type: application/json
4Content-Length: 0开关公网访问
请求结构
Plain Text
1PUT /v{version}/instance/{instanceId}?modifyPublicAccess HTTP/1.1
2HOST: rds.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "publicAccess":"publicAccess"
7}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | string | 是 | URL参数 | API 版本号 |
| instanceId | string | 是 | URL参数 | 指定实例Id |
| publicAccess | Boolean | 是 | RequestBody参数 | true：开启公网访问 false：关闭公网访问 |
返回头域
除公共头域，无其它特殊头域。
返回参数
无特殊返回参数
请求示例
Plain Text
1PUT /v1/instance/r-mmsde3nh?modifyPublicAccess HTTP/1.1
2HOST: rds.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7 "publicAccess": true
8}返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
3Content-Type: application/json
4Content-Length: 0修改备份策略
说明
- 默认每天凌晨一点开始备份。
- 云数据库 RDS 赠送您100%*本地磁盘空间大小的备份存储空间。
- 备份超过免费空间时会自动删除旧备份。若您设置了允许备份超过免费赠送空间，则超过该大小的备份存储将会额外计费，详情请参考备份存储计费。
请求结构
Plain Text
1PUT /v{version}/instance/{instanceId}?modifyBackupPolicy HTTP/1.1
2HOST: rds.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "backupDays": "backupDays",
7 "backupTime": "backupTime",
8 "persistent": persistent,
9 "expireInDays": expireInDays
10}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | string | 是 | URL参数 | API 版本号 |
| instanceId | string | 是 | URL参数 | 指定实例Id |
| backupDays | String | 是 | RequestBody参数 | 以英文半角逗号分隔的备份时日间，周日为第一天，取值0 举例："0,1,2,3,5,6" |
| backupTime | String | 是 | RequestBody参数 | 备份开始时间，使用UTC时间 举例："17:00:00Z" |
| persistent | Boolean | 是 | RequestBody参数 | 是否启用备份数据持久化 |
| expireInDays | Int | 否 | RequestBody参数 | 持久化天数，范围7-730天；未启用则为0或不填 |
返回头域
除公共头域，无其它特殊头域。
返回参数
无特殊返回参数
请求示例
Plain Text
1PUT /v1/instance/r-mfj4jsd9?modifyBackupPolicy HTTP/1.1
2HOST: rds.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7 "backupDays": "0,1,2,3,4,5,6",
8 "backupTime": "17:00:00Z",
9 "persistent": true,
10 "expireInDays": 10
11}返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
3Content-Type: application/json
4Content-Length: 0实例扩缩容
为指定云数据库 RDS 所用资源扩缩容，目前支持对主实例或只读实例的内存、磁盘、cpu数进行扩缩容操作，支持对代理实例的节点数做扩缩容操作。
说明
- 实例计费方式采用后付费时，可弹性扩缩容；采用预付费方式，不能进行缩容操作。
- 只有实例available状态时才可以进行扩缩容操作。
- 实例扩缩容之后会重启一次。
- 异步接口，可通过查询实例详情接口查看instanceStatus是否恢复。
请求结构
Plain Text
1PUT /v{version}/instance/{instanceId}?resize HTTP/1.1
2HOST: rds.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "cpuCount" : cpuCount,
7 "memoryCapacity" : memoryCapacity,
8 "volumeCapacity" : volumeCapacity,
9 "nodeAmount" : nodeAmount,
10 "isDirectPay" : isDirectPay
11}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | string | 是 | URL参数 | API 版本号 |
| instanceId | string | 是 | URL参数 | 指定实例Id |
| cpuCount | Int | 否 | RequestBody参数 | cpu核数。取值参考。主实例或只读实例变配时至少填写cpuCount、memoryCapacity、volumeCapacity其中的一个。 |
| memoryCapacity | Int | 否 | RequestBody参数 | 内存大小，单位GB。取值参考。主实例或只读实例变配时至少填写cpuCount、memoryCapacity、volumeCapacity其中的一个。 |
| volumeCapacity | Int | 否 | RequestBody参数 | 磁盘大小，单位GB，每5G递增。取值参考。主实例或只读实例变配时至少填写cpuCount、memoryCapacity、volumeCapacity其中的一个。 |
| nodeAmount | Int | 否 | RequestBody参数 | 代理实例节点数。取值参考。代理实例变配时此项必填。 |
| isDirectPay | Boolean | 否 | RequestBody参数 | 是否进行直接支付，默认false，设置为直接支付的变配订单会直接扣款，不需要在走支付逻辑 |
返回头域
除公共头域，无其它特殊头域。
返回参数
无特殊返回参数
请求示例
Plain Text
1PUT /v1/instance/r-mdjei8sh?resize HTTP/1.1
2HOST: rds.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7 "cpuCount" : 4,
8 "memoryCapacity" : 8,
9 "volumeCapacity" : 40
10}返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
3Content-Type: application/json
4Content-Length: 0