账号管理接口说明
更新时间：2025-08-21
创建账号
接口描述
本接口用于在云数据库 GaiaDB-X 实例下创建一个数据库账号
请求结构
Plain Text
1POST /v{version}/instance/{instanceId}/account?clientToken={clientToken} HTTP/1.1
2HOST: drds.bj.baidubce.com
3Authorization: authorization string
4{
5 "accountName": accountName,
6 "password": password,
7 "databasePrivileges": databasePrivileges,
8 "remark": remark
9}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URI参数 | API版本号 |
| instanceId | String | 是 | URI参数 | 实例ID |
| clientToken | String | 是 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串 |
| accountName | String | 是 | RequestBody参数 | 账号名称，由小写字母、数字、下划线组成、字母开头，字母或数字结尾，最长16个字符 |
| password | String | 是 | RequestBody参数 | 账号密码，由字母、数字和特殊字符（!@#$%^_）中的至少两种组成，长度8-32位。密码需要加密传输，禁止明文传输，详情请参考密码加密传输规范定义 |
| remark | String | 否 | RequestBody参数 | 账号备注说明 |
| databasePrivileges | List<DatabasePrivilege> | 否 | RequestBody参数 | 授权数据库列表信息 |
DatabasePrivilege
| 参数名称 | 类型 | 描述 |
|---|---|---|
| dbName | String | 数据库名称 |
| authType | String | 授权类型，ReadOnly、ReadWrite，账号权限 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
无特殊响应参数
请求示例
Plain Text
1POST https://drds.bj.baidubce.com/v1/instance/drds265l1gltivi/account？clientToken=159c9a5d-252a-47ea-bee8-70176e5c4d06
2Host: drds.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4{
5 "accountName": "user2",
6 "password": "6af2af9b31fe977d624237938c46d670",
7 "databasePrivileges": [{
8 "dbName": "dbtest",
9 "authType": "ReadWrite"
10 }],
11 "remark": "user1"
12}响应示例
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}/account/{accountName} HTTP/1.1
2HOST: drds.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URI参数 | API版本号 |
| instanceId | String | 是 | URI参数 | 实例ID |
| accountName | String | 是 | URI参数 | 账号名称 |
响应头域
除公共头域外，无其它特殊头域。
响应参数 无特殊响应参数
请求示例
Plain Text
1DELETE https://drds.bj.baidubce.com/v1/instance/drds265l1gltivi/account/user1
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}/account HTTP/1.1
2HOST: drds.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URI参数 | API版本号 |
| instanceId | String | 是 | URI参数 | 实例ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| accounts | List<Account> | 账号列表 |
Account
| 参数名称 | 类型 | 描述 |
|---|---|---|
| accountName | String | 账号名称 |
| remark | String | 备注说明 |
| status | String | 账号状态 |
| databasePrivileges | List<DatabasePrivilege> | 授权数据库列表信息 |
请求示例
Plain Text
1GET https://drds.bj.baidubce.com/v1/instance/drds265l1gltivi/account
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 "account": [
6 {
7 "accountName": "user1",
8 "status": "Available",
9 "remark": "user1",
10 "databasePrivileges": [
11 {
12 "dbName": "dbtest",
13 "authType": "ReadOnly"
14 }
15 ]
16 },
17 {
18 "accountName": "user2",
19 "status": "Available",
20 "remark": "??user1",
21 "databasePrivileges": [
22 {
23 "dbName": "dbtest",
24 "authType": "ReadWrite"
25 }
26 ]
27 }
28 ]
29}查询账号详情
接口描述
本接口用于查询云数据库 GaiaDB-X 实例下的一个数据库账号详情
请求结构
Plain Text
1GET /v{version}/instance/{instanceId}/account/{accountName} HTTP/1.1
2HOST: drds.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URI参数 | API版本号 |
| instanceId | String | 是 | URI参数 | 实例ID |
| accountName | String | 是 | URI参数 | 账号名称 |
响应头域
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ETag | String | 当前版本号，在修改的时候需要把当前ETag通过header的方式传递回去 |
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| accountName | String | 账号名称 |
| remark | String | 备注说明 |
| status | String | 账号状态 |
| databasePrivileges | List<DatabasePrivilege> | 授权数据库列表信息 |
请求示例
Plain Text
1GET https://drds.bj.baidubce.com/v1/instance/drds265l1gltivi/account/user1
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
3ETag: v10
4Content-Type: application/json
5{
6
7 "accountName": "user1",
8 "status": "Available",
9 "remark": "user1",
10 "databasePrivileges": [
11 {
12 "dbName": "dbtest",
13 "authType": "ReadOnly"
14 }
15 ]
16}修改账号密码
接口描述
本接口用于修改云数据库 GaiaDB-X 实例下一个数据库账号的密码
请求结构
Plain Text
1PUT /v{version}/instance/{instanceId}/account/{accountName}?modifyPassword HTTP/1.1
2HOST: drds.bj.baidubce.com
3Authorization: authorization string
4{
5 "password": password
6}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URI参数 | API版本号 |
| instanceId | String | 是 | URI参数 | 实例ID |
| accountName | String | 是 | URI参数 | 账号名称 |
| password | String | 是 | RequestBody参数 | 账号密码，由字母、数字和特殊字符（!@#$%^_）中的至少两种组成，长度8-32位。密码需要加密传输，禁止明文传输，详情请参考密码加密传输规范定义 |
响应头域
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ETag | String | 当前版本号，在修改的时候需要把当前ETag通过header的方式传递回去 |
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| accountName | String | 账号名称 |
| remark | String | 备注说明 |
| status | String | 账号状态 |
| databasePrivileges | List<DatabasePrivilege> | 授权数据库列表信息 |
请求示例
Plain Text
1PUT https://drds.bj.baidubce.com/v1/instance/drds265l1gltivi/account/user1?modifyPassword
2Host: drds.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4{
5 "password": "6af2af9b31fe977d624237938c46d670"
6}响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
3Content-Type: application/json修改账号权限
接口描述
本接口用于修改云数据库 GaiaDB-X 实例下一个数据库账号的权限
请求结构
Plain Text
1PUT /v{version}/instance/{instanceId}/account/{accountName}?modifyPrivilege HTTP/1.1
2HOST: drds.bj.baidubce.com
3x-bce-if-match：{ETag}
4Authorization: authorization string
5{
6 "databasePrivileges": databasePrivileges
7}请求头域
| 参数名称 | 类型 | 描述 |
|---|---|---|
| x-bce-if-match | String | 通过账号详情接口获取到的ETag值 |
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URI参数 | API版本号 |
| instanceId | String | 是 | URI参数 | 实例ID |
| accountName | String | 是 | URI参数 | 账号名称 |
| databasePrivileges | List<DatabasePrivilege> | 是 | RequestBody参数 | 更新账号数据权限列表 |
响应头域
除公共头域，无其它特殊头域。
响应参数 无特殊响应参数。
请求示例
Plain Text
1PUT https://drds.bj.baidubce.com/v1/instance/drds265l1gltivi/account/user1?updatePrivilege
2Host: drds.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4{
5 "databasePrivileges": [
6 {
7 "dbName": "dbtest",
8 "authType": "ReadOnly"
9 }
10 ]
11}响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
3Content-Type: application/json