欢迎访问 OceanBase 官网获取更多信息：https://www.oceanbase.com/
功能说明
创建数据库时使用的接口。
调用说明
接口约束
- 调用者需要通过 OCP 应用服务鉴权。
- 调用者需要具备指定租户的修改权限。
请求路径
POST /api/v2/ob/clusters/{id}/tenants/{tenantId}/databases
请求参数
path 参数
参数 | 类型 | 必选 | 示例值 | 描述 |
|---|---|---|---|---|
id | Integer | 是 | 1 | 集群 ID |
tenantId | Integer | 是 | 5 | 租户 ID |
body 参数
参数 | 类型 | 必选 | 示例值 | 描述 |
|---|---|---|---|---|
dbName | String | 是 | db1 | 数据库名 |
collation | String | 否 | utf8mb4_general_ci | 校对集，取值范围： binary utf8mb4 gbk gb18030缺省为 utf8mb4_general_ci ORACLE 租户暂不支持此参数 |
primaryZone | String | 否 | zone1;zone2,zone3 | Zone 优先级 |
readonly | Boolean | 是 | false | 是否只读 |
返回结果
参数 | 类型 | 说明 |
|---|---|---|
data | Object | 数据库对象，数据库的数据结构见下表。 |
successful | Boolean | 请求是否成功。 |
timestamp | Datetime | 服务端完成请求的时间戳。 |
duration | Integer | 服务端处理请求的时间（毫秒）。 |
status | Integer | 符合 HTTP Status 规范的编码。 |
traceId | String | 请求的 Trace Id，用于排查问题。 |
server | String | 响应请求的应用服务的地址。 |
数据库的数据结构
参数 | 类型 | 说明 |
|---|---|---|
dbName | String | 数据库名 |
charset | String | 字符集 |
collation | String | 校对集 |
readonly | Boolean | 是否只读 |
createTime | Datetime | 创建时间 |
connectionUrls | Array | OBProxy与连接串的列表 |
├─ connectionStringType | String | 连接串类型，取值范围： OBPROXY DIRECT 直连 |
├─ obProxyAddress | String | OBProxy 地址，仅当连接串类型为 OBPROXY 时有效 |
├─ obProxyPort | Integer | OBProxy 端口，仅当连接串类型为 OBPROXY 时有效 |
├─ connectionString | String | 连接串 |
requiredSize | Integer | 数据库的 required_size |
id | Integer | 数据库的 ID |
示例
请求示例
在集群 1、租户 1000001 下创建数据库。
POST /api/v2/ob/clusters/1/tenants/1000001/databases?id=1&tenantId=1000001
{
"dbName": "db1",
"collation": "utf8mb4_general_ci",
"readonly": false,
}
返回示例
{
"data": {
"charset": "utf8mb4",
"collation": "utf8mb4_general_ci",
"createTime": "2021-09-07T10:34:22.583681+08:00",
"dbName": "db1",
"id": 1100611139404827,
"readonly": false
},
"duration": 311,
"server": "a83ad33525",
"status": 200,
"successful": true,
"timestamp": "2021-09-07T10:34:22.626+08:00",
"traceId": "2442edacd20f4442"
}
欢迎访问 OceanBase 官网获取更多信息：https://www.oceanbase.com/
