库
更新时间：2024-12-13
库管理
ListDatabases
获取数据库信息列表
请求原型
GET /v1/database请求参数
| 名称 | 类型 | 位置 | 必须 | 描述 |
|---|---|---|---|---|
| pageNo | Integer | QueryString | 否 | 页码，默认1 |
| pageSize | Integer | QueryString | 否 | 每页查询记录数，默认10 |
| namePattern | String | QueryString | 否 | 搜索关键词 |
响应参数
| 名称 | 类型 | 描述 |
|---|---|---|
| pageNo | Integer | 当前页数 |
| pageSize | Integer | 每页条数 |
| totalCount | Integer | 总数 |
| databases | List<Database> | 数据库信息列表 |
Database对象
| 名称 | 类型 | 描述 |
|---|---|---|
| database | String | 数据库名称 |
| creator | String | 创建者 |
| createTime | String | 创建时间 |
| description | String | 描述信息 |
错误码
公有云标准错误返回码
| Code | message | HTTP状态码 | 描述 |
|---|---|---|---|
| InternalError | We encountered an internal error. Please try again. | 500 | 服务器内部错误 |
请求示例
GET /v1/database?pageNo=1&pageSize=10 HTTP/1.1
Host: edap.bj.baidubce.com
Content-Length: 0响应示例
HTTP/1.1 200 OK
Content-Length: xxxx
Content-Type: application/json
{
"pageNo": 1,
"pageSize": 10,
"totalCount": 2,
"databases": [
{
"createTime": "2023-11-22T08:21:27Z",
"creator": "root",
"database": "default",
"description": "this is default db"
},
{
"createTime": "2023-12-27T15:56:42Z",
"creator": "root",
"database": "db",
"description": "my db"
}
]
}ListDatabaseNames
接口说明
获取用户数据库名称列表
请求原型
GET /v1/database?name请求参数
| 名称 | 类型 | 位置 | 必须 | 描述 |
|---|---|---|---|---|
| pageNo | Integer | QueryString | 否 | 页码，默认1 |
| pageSize | Integer | QueryString | 否 | 每页查询记录数，默认10 |
| namePattern | String | QueryString | 否 | 搜索关键词 |
响应参数
| 名称 | 类型 | 描述 |
|---|---|---|
| pageNo | Integer | 当前页数 |
| pageSize | Integer | 每页条数 |
| totalCount | Integer | 总数 |
| databaseNames | List<String> | 数据库名称列表 |
错误码
公有云标准错误返回码
| Code | message | HTTP状态码 | 描述 |
|---|---|---|---|
| InternalError | We encountered an internal error. Please try again. | 500 | 服务器内部错误 |
请求示例
GET /v1/database?name&pageNo=1&pageSize=10 HTTP/1.1
Host: edap.bj.baidubce.com
Content-Length: 0响应示例
HTTP/1.1 200 OK
Content-Length: xxxx
Content-Type: application/json
{
"pageNo": 1,
"pageSize": 10,
"totalCount": 2,
"databaseNames": [
"default",
"dept"
]
}GetDatabase
获取数据库信息
请求原型
GET /v1/database/${databaseName}请求参数
| 名称 | 类型 | 位置 | 必须 | 说明 |
|---|---|---|---|---|
| databaseName | String | URL | 是 | 数据库名 |
响应参数
| 名称 | 类型 | 描述 |
|---|---|---|
| database | String | 数据库名称 |
| locationId | String | 数据湖存储id |
| locationUri | String | 库路径 |
| creator | String | 创建者 |
| createTime | String | 创建时间 |
| description | String | 描述信息 |
| owner | String | 负责人名称 |
| ownerType | String | 负责人类型，枚举值:{USER，ROLE ，GROUP} |
| properties | Map | 定义数据库的参数和属性的键值对 |
错误码
公有云标准错误返回码
| Code | message | HTTP状态码 | 描述 |
|---|---|---|---|
| DatabaseNotFound | Database not found. | 404 | 数据库不存在 |
| InternalError | We encountered an internal error. Please try again. | 500 | 服务器内部错误 |
请求示例
GET /v1/database/default HTTP/1.1
Host: edap.bj.baidubce.com
Content-Length: 0响应示例
HTTP/1.1 200 OK
Content-Length: xxxx
Content-Type: application/json
{
"createTime": "2023-11-22T08:21:27Z",
"creator": "root",
"database": "default",
"description": "this is default db",
"locationId": "default_location",
"locationUri": "bos://default"
"owner": "hdfs",
"ownerType": "USER",
"properties": {
"department": "big data"
}
}CreateDatabase
新增数据库
请求原型
POST /v1/database请求参数
| 名称 | 类型 | 位置 | 是否必须 | 描述 |
|---|---|---|---|---|
| database | String | Body | 是 | 数据库名称，仅支持字母、数字和下划线，大小写不敏感，账户下全局唯一，长度不大于32个字符 |
| locationId | String | Body | 是 | 数据湖存储id |
| owner | String | Body | 否 | 负责人名称 |
| ownerType | String | Body | 否 | 负责人类型，枚举值:{USER，ROLE ，GROUP} |
| properties | Map | Body | 否 | 定义数据库的参数和属性的键值对 |
| description | String | Body | 否 | 描述信息，长度不大于1024个字符 |
响应参数
除公共响应参数外，无特殊响应。
错误码
公有云标准错误返回码
| Code | message | HTTP状态码 | 描述 |
|---|---|---|---|
| BadRequest | Bad request, please check your request | 400 | 请求体规则校验错误 |
| AccessDenied | Access Denied. | 403 | 无权限 |
| DatabaseAlreadyExist | Database already exist. | 409 | 数据库已存在 |
| InternalError | We encountered an internal error. Please try again. | 500 | 服务器内部错误 |
请求示例
POST /v1/database HTTP/1.1
Content-Length: xxxx
Content-Type: application/json
{
"database": "db_01",
"locationId": "loc_01",
"properties": {
"department": "applied mathematics"
},
"description": "applied mathematics"
}响应示例
HTTP/1.1 204 No Content
Content-Length: 0UpdateDatabase
更新数据库信息
请求原型
PUT /v1/database/${databaseName}请求参数
| 名称 | 类型 | 位置 | 是否必须 | 描述 |
|---|---|---|---|---|
| databaseName | String | URL | 是 | 原始数据库名称 |
| database | String | Body | 是 | 数据库名称，仅支持字母、数字和下划线，大小写不敏感，账户下全局唯一，长度不大于32个字符 |
| locationId | String | Body | 是 | 数据湖存储id |
| owner | String | Body | 否 | 负责人名称 |
| ownerType | String | Body | 否 | 负责人类型，枚举值:{USER，ROLE ，GROUP} |
| properties | Map | Body | 否 | 定义数据库的参数和属性的键值对 |
| description | String | Body | 否 | 描述信息，长度不大于1024个字符 |
响应参数
除公共响应参数外，无特殊响应。
错误码
公有云标准错误返回码
| Code | message | HTTP状态码 | 描述 |
|---|---|---|---|
| BadRequest | Bad request, please check your request | 400 | 请求体规则校验错误 |
| AccessDenied | Access Denied. | 403 | 无权限 |
| DatabaseAlreadyExist | Database already exist. | 409 | 数据库已存在 |
| DatabaseNotFound | Database not found. | 404 | 数据库不存在 |
| InternalError | We encountered an internal error. Please try again. | 500 | 服务器内不错误 |
请求示例
POST /v1/database/db_01 HTTP/1.1
Host: edap.bj.baidubce.com
Content-Length: xxxx
Content-Type: application/json
{
"database": "db_02",
"locationId": "loc_02",
"properties": {
"department": "big data"
},
"description": "big data"
}响应示例
HTTP/1.1 204 No Content
Content-Length: 0DeleteDatabase
删除数据库（仅允许删除没有数据库表格的数据库）
请求原型
DELETE /v1/database/${databaseName}请求参数
| 名称 | 类型 | 位置 | 是否必须 | 描述 |
|---|---|---|---|---|
| databaseName | String | URL | 是 | 数据库名称 |
响应参数
除公共响应参数外，无特殊响应。
错误码
公有云标准错误返回码
| Code | message | HTTP状态码 | 描述 |
|---|---|---|---|
| BadRequest | Bad request, please check your request | 400 | 该库下存在表无法删除 |
| AccessDenied | Access Denied. | 403 | 无权限 |
| DatabaseNotFound | Database not found. | 404 | 数据库不存在 |
| InternalError | We encountered an internal error. Please try again. | 500 | 服务器内部错误 |
请求示例
DELETE /v1/database/db_01 HTTP/1.1
Host: edap.bj.baidubce.com
Content-Length: 0响应示例
HTTP/1.1 204 No Content
Content-Length: 0