数据库管理接口说明
更新时间：2025-08-21
创建数据库
接口描述
本接口用于在云数据库 GaiaDB-X 实例下创建一个数据库
请求结构
Plain Text
1POST /v{version}/instance/{instanceId}/database?ClientToken={clientToken} HTTP/1.1
2HOST: drds.bj.baidubce.com
3Authorization: authorization string
4{
5 "dbName": dbName,
6 "characterSetName": characterSetName,
7 "remark": remark
8}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URI参数 | API版本号 |
| instanceId | String | 是 | URI参数 | 实例ID |
| clientToken | String | 是 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串 |
| dbName | String | 是 | RequestBody参数 | 数据库名称，由小写字母、数字、下划线组成，字母开头，字母或数字结尾，最长64个字符 |
| characterSetName | String | 是 | RequestBody参数 | 字符集，目前仅支持utf8、gbk两种字符集 |
| remark | String | 否 | RequestBody参数 | 数据库备注说明 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
无特殊响应参数
请求示例
Plain Text
1POST https://drds.bj.baidubce.com/v1/instance/drdsuc6qx3cpnh3/database?clientToken=536c5bbc-a52a-42a6-a48a-c3b0cb7013c4
2Host: drds.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4{
5 "dbName": "dbtest",
6 "characterSetName": "utf8",
7 "remark": "remark"
8}响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
3Content-Type: application/json删除数据库
接口描述
本接口用于在云数据库 GaiaDB-X 实例下删除一个指定数据库
请求结构
Plain Text
1DELETE /v{version}/instance/{instanceId}/database/{dbName} HTTP/1.1
2HOST: drds.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URI参数 | API版本号 |
| instanceId | String | 是 | URI参数 | 实例ID |
| dbName | String | 是 | URI参数 | 数据库名称 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
无特殊响应参数
请求示例
Plain Text
1DELETE https://drds.bj.baidubce.com/v1/instance/drdsuc6qx3cpnh3/database/dbtest
2Host: drds.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04: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查询数据库列表
接口描述
本接口用于查询云数据库 GaiaDB-X 实例下的数据库列表
请求结构
Plain Text
1GET /v{version}/instance/{instanceId}/database HTTP/1.1
2HOST: drds.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URI参数 | API版本号 |
| instanceId | String | 是 | URI参数 | 实例ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| databases | List<Database> | API版本号 |
Database
| 参数名称 | 类型 | 描述 |
|---|---|---|
| dbname | String | 数据库名称 |
| status | String | 数据库状态 |
| remakr | String | 数据库备注 |
| characterSetName | String | 字符集 |
| accountPrivileges | List<PrivilegeModel> | 绑定的账号权限 |
PrivilegeModel
| 参数名称 | 类型 | 描述 |
|---|---|---|
| accountName | String | 账号名称 |
| authType | String | 权限类型 |
请求示例
Plain Text
1GET https://drds.bj.baidubce.com/v1/instance/drdsuc6qx3cpnh3/database
2Host: drds.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04: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 "databases": [
6 {
7 "dbName": "dbtest",
8 "status": "Available",
9 "remark": "remark",
10 "characterSetName": "utf8",
11 "accountPrivileges": [
12 {
13 "accountName": "user1",
14 "authType": "ReadOnly"
15 },
16 {
17 "accountName": "user2",
18 "authType": "ReadWrite"
19 }
20 ]
21 }
22 ]
23}