跳到主要内容

1. 创建工作空间接口

描述:创建工作空间,并返回此工空间ID(workspaceId)。

1.1.接口URL

Post http://${server-host}:${server-port}/api/v1/createWorkspace  

1.2.接口入参

字段名字段类型是否必填描述
userKeyStringY激活码
modeStringY线上: online/离线: offline
dbTyeStringY数据库类型: mysql/postgresql/opengauss/oracle
hostStringN数据库主机地址
portStringN数据库端口号
databaseStringN数据库名称
schemasStringN模式列表(pg/opengauss/orcale需要填写),若有多个按英文逗号分隔且区分大小写
dbUserStringN访问数据库的用户名
dbPasswordStringN用户名对应密码
ddlTextStringN工作空间对应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. 接口出参:

字段名字段类型描述
codeint状态码
messageString描述信息
dataObject数据信息

data数据结构

字段名字段类型描述
workspaceIdString工作空间ID

出参示例

  • 成功
{
"code": 200,
"message": "操作成功",
"data": {
"workspaceId": "1730508173442965506"
}
}
  • 失败
{
"code": 400,
"message": "server.validate.failed",
"data": null
}