云数据库 GaiaDB-X

    数据库管理接口说明

    创建数据库

    接口描述

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

    请求结构

    POST /v{version}/instance/{instanceId}/database?ClientToken={clientToken} HTTP/1.1
    HOST: drds.bj.baidubce.com
    Authorization: authorization string
    {
        "dbName": dbName,
        "characterSetName": characterSetName,
        "remark": remark
    }

    请求头域

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

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    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参数 数据库备注说明

    响应头域

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

    响应参数

    无特殊响应参数

    请求示例

    POST https://drds.bj.baidubce.com/v1/instance/drdsuc6qx3cpnh3/database?clientToken=536c5bbc-a52a-42a6-a48a-c3b0cb7013c4
    Host: drds.bj.baidubce.com
    Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
    {
        "dbName": "dbtest",
        "characterSetName": "utf8",
        "remark": "remark"
    }

    响应示例

    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}/database/{dbName} HTTP/1.1
    HOST: drds.bj.baidubce.com
    Authorization: authorization string

    请求头域

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

    请求参数

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

    响应头域

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

    响应参数

    无特殊响应参数

    请求示例

    DELETE https://drds.bj.baidubce.com/v1/instance/drdsuc6qx3cpnh3/database/dbtest
    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}/database HTTP/1.1
    HOST: drds.bj.baidubce.com
    Authorization: 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 权限类型

    请求示例

    GET https://drds.bj.baidubce.com/v1/instance/drdsuc6qx3cpnh3/database
    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
    {
        "databases": [
            {
                "dbName": "dbtest",
                "status": "Available",
                "remark": "remark",
                "characterSetName": "utf8",
                "accountPrivileges": [
                    {
                        "accountName": "user1",
                        "authType": "ReadOnly"
                    },
                    {
                        "accountName": "user2",
                        "authType": "ReadWrite"
                    }
                ]
            }
        ]
    }
    上一篇
    实例管理接口说明
    下一篇
    数据表管理接口说明