上云无忧 > 文档中心 > 百度智能云云数据库 GaiaDB-X 账号管理接口说明
云数据库 GaiaDB-X
百度智能云云数据库 GaiaDB-X 账号管理接口说明

文档简介:
本接口用于在云数据库 GaiaDB-X 实例下创建一个数据库账号。 请求结构: POST /v{version}/instance/{instanceId}/account?clientToken={clientToken} HTTP/1.1 HOST: drds.bj.baidubce.com Authorization: authorization string
*此产品及展示信息均由百度智能云官方提供。免费试用 咨询热线:400-826-7010,为您提供专业的售前咨询,让您快速了解云产品,助您轻松上云! 微信咨询
  免费试用、价格特惠

创建账号

接口描述

本接口用于在云数据库 GaiaDB-X 实例下创建一个数据库账号

请求结构

POST /v{version}/instance/{instanceId}/account?clientToken={clientToken} HTTP/1.1
HOST: drds.bj.baidubce.com
Authorization: authorization string
{
    "accountName": accountName,
    "password": password,
    "databasePrivileges": databasePrivileges,
    "remark": remark
}

请求头域

除公共头域外,无其它特殊头域。

请求参数

参数名称 类型 是否必需 参数位置 描述
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,账号权限

响应头域

除公共头域外,无其它特殊头域。

响应参数

无特殊响应参数

请求示例

POST https://drds.bj.baidubce.com/v1/instance/drds265l1gltivi/account?
clientToken=159c9a5d-252a-47ea-bee8-70176e5c4d06
Host: drds.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z
/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
    "accountName": "user2",
    "password": "6af2af9b31fe977d624237938c46d670",
    "databasePrivileges": [{
        "dbName": "dbtest",
        "authType": "ReadWrite"
    }],
    "remark": "user1"
}

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
Content-Type: application/json

删除账号

接口描述

本接口用于在云数据库 GaiaDB-X 实例下删除一个数据库账号

请求结构

DELETE /v{version}/instance/{instanceId}/account/{accountName} HTTP/1.1
HOST: drds.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外,无其它特殊头域。

请求参数

参数名称 类型 是否必需 参数位置 描述
version String 是 URI参数 API版本号
instanceId String 是 URI参数 实例ID
accountName String 是 URI参数 账号名称

响应头域

除公共头域外,无其它特殊头域。

响应参数 无特殊响应参数

请求示例

DELETE https://drds.bj.baidubce.com/v1/instance/drds265l1gltivi/account/user1
Host: drds.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z
/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
Content-Type: application/json

查询账号列表

接口描述

本接口用于查询云数据库 GaiaDB-X 实例下的数据库账号列表

请求结构

GET /v{version}/instance/{instanceId}/account HTTP/1.1
HOST: drds.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外,无其它特殊头域。

请求参数

参数名称 类型 是否必需 参数位置 描述
version String 是 URI参数 API版本号
instanceId String 是 URI参数 实例ID

响应头域

除公共头域外,无其它特殊头域。

响应参数

参数名称 类型 描述
accounts List<Account> 账号列表

Account

参数名称 类型 描述
accountName String 账号名称
remark String 备注说明
status String 账号状态
databasePrivileges List<DatabasePrivilege> 授权数据库列表信息

请求示例

GET https://drds.bj.baidubce.com/v1/instance/drds265l1gltivi/account
Host: drds.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z
/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
Content-Type: application/json
{
    "account": [
        {
            "accountName": "user1",
            "status": "Available",
            "remark": "user1",
            "databasePrivileges": [
                {
                    "dbName": "dbtest",
                    "authType": "ReadOnly"
                }
            ]
        },
        {
            "accountName": "user2",
            "status": "Available",
            "remark": "??user1",
            "databasePrivileges": [
                {
                    "dbName": "dbtest",
                    "authType": "ReadWrite"
                }
            ]
        }
    ]
}

查询账号详情

接口描述

本接口用于查询云数据库 GaiaDB-X 实例下的一个数据库账号详情

请求结构

GET /v{version}/instance/{instanceId}/account/{accountName} HTTP/1.1
HOST: drds.bj.baidubce.com
Authorization: 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> 授权数据库列表信息

请求示例

GET https://drds.bj.baidubce.com/v1/instance/drds265l1gltivi/account/user1
Host: drds.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z
/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
ETag: v10
Content-Type: application/json
{
 
    "accountName": "user1",
    "status": "Available",
    "remark": "user1",
    "databasePrivileges": [
        {
            "dbName": "dbtest",
            "authType": "ReadOnly"
        }
    ]
}

修改账号密码

接口描述

本接口用于修改云数据库 GaiaDB-X 实例下一个数据库账号的密码

请求结构

PUT /v{version}/instance/{instanceId}/account/{accountName}?modifyPassword HTTP/1.1
HOST: drds.bj.baidubce.com
Authorization: authorization string
{
    "password": password
}

请求头域

除公共头域外,无其它特殊头域。

请求参数

参数名称 类型 是否必需 参数位置 描述
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> 授权数据库列表信息

请求示例

PUT https://drds.bj.baidubce.com/v1/instance/drds265l1gltivi/account/user1?modifyPassword
Host: drds.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z
/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
    "password": "6af2af9b31fe977d624237938c46d670"
}

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
Content-Type: application/json

修改账号权限

接口描述

本接口用于修改云数据库 GaiaDB-X 实例下一个数据库账号的权限

请求结构

PUT /v{version}/instance/{instanceId}/account/{accountName}?modifyPrivilege HTTP/1.1
HOST: drds.bj.baidubce.com
x-bce-if-match:{ETag}
Authorization: authorization string
{
    "databasePrivileges": databasePrivileges
}

请求头域

参数名称 类型 描述
x-bce-if-match String 通过账号详情接口获取到的ETag值

请求参数

参数名称 类型 是否必需 参数位置 描述
version String 是 URI参数 API版本号
instanceId String 是 URI参数 实例ID
accountName String 是 URI参数 账号名称
databasePrivileges List<DatabasePrivilege> 是 RequestBody参数 更新账号数据权限列表

响应头域

除公共头域,无其它特殊头域。

响应参数 无特殊响应参数。

请求示例

PUT https://drds.bj.baidubce.com/v1/instance/drds265l1gltivi/account/user1?updatePrivilege
Host: drds.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z
/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
    "databasePrivileges": [
        {
            "dbName": "dbtest",
            "authType": "ReadOnly"
        }
    ]
}

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
Content-Type: application/json

相似文档
  • 本接口用于获取云数据库 GaiaDB-X 实例的IP白名单 请求结构: GET /v{version}/instance/{instanceId}/securityIp HTTP/1.1 HOST: drds.bj.baidubce.com Authorization: authorization string 请求头域: 除公共头域外,无其它特殊头域。
  • 本接口用于查询可用区列表。 请求结构: GET /v{version}/zone HTTP/1.1 HOST: drds.bj.baidubce.com Authorization: authorization string 请求头域: 除公共头域外,无其它特殊头域。
  • 以查询实例列表接口为例,进行说明。请查看以下示例: python示例: import json import httplib from datetime import datetime import sign_sample # 鉴权计算模块,参考百度云鉴权认证机制 if __name__ == "__main__":
  • 2021-06-29 体验优化 ,支持多规格数据传输任务变更配置。 2021-06-29 体验优化 ,支持监控报警能力升级(BCM)。 2021-04-28 体验优化 ,新增三种任务状态启动中、运行中和已失效。 2021-04-12 新功能 ,支持源端、目标端为云数据库专属集群 DCC 的数据迁移。
  • 2020年8月20日,百度智能云对数据库产品进行了全面的品牌升级,百度自研云数据库品牌 GaiaDB 重磅发布! 2019年8月15日,百度智能云对数据库产品进行了品牌统一,数据库产品升级为云数据库产品。
官方微信
联系客服
400-826-7010
7x24小时客服热线
分享
  • QQ好友
  • QQ空间
  • 微信
  • 微博
返回顶部