1. 创建工作空间接口
描述:创建工作空间,并返回此工空间ID(workspaceId)。
1.1.接口URL
Post http://${server-host}:${server-port}/api/v1/createWorkspace
1.2.接口入参
字段名 | 字段类型 | 是否必填 | 描述 |
---|---|---|---|
userKey | String | Y | 激活码 |
mode | String | Y | 线上: online/离线: offline |
dbTye | String | Y | 数据库类型: mysql/postgresql/opengauss/oracle |
host | String | N | 数据库主机地址 |
port | String | N | 数据库端口号 |
database | String | N | 数据库名称 |
schemas | String | N | 模式列表(pg/opengauss/orcale需要填写),若有多个按英文逗号分隔且区分大小写 |
dbUser | String | N | 访问数据库的用户名 |
dbPassword | String | N | 用户名对应密码 |
ddlText | String | N | 工作空间对应ddl文本(offline模式) |
入参示例
- 离线模式(offline)
{
"mode": "offline",
"userKey": "CB698418-88B25371-67F15F01-XXXXXXXX",
"dbType": "mysql",
"ddlText": "CREATE TABLE `organization` (`org_id` bigint(20) NOT NULL);"
}
- 在线模式(online)
{
"mode": "online",
"userKey": "CB698418-88B25371-67F15F01-XXXXXXXX",
"dbType": "mysql",
"host": "localhost",
"port": "3306",
"database": "pawsql",
"dbUser": "root",
"dbPassword": "password"
}
1.3. 接口出参:
字段名 | 字段类型 | 描述 |
---|---|---|
code | int | 状态码 |
message | String | 描述信息 |
data | Object | 数据信息 |
data数据结构
字段名 | 字段类型 | 描述 |
---|---|---|
workspaceId | String | 工作空间ID |
出参示例
- 成功
{
"code": 200,
"message": "操作成功",
"data": {
"workspaceId": "1730508173442965506"
}
}
- 失败
{
"code": 400,
"message": "server.validate.failed",
"data": null
}