A valid request URL is required to generate request examples

{
  "code": 200,
  "message": "Success",
  "data": {
    "workspaceId": "1730508173442965506"
  }
}

创建工作空间

创建工作空间并返回 workspaceId，支持离线模式（DDL 文本）和在线模式（数据库连接）。

支持的 dbType 值

dbType	Database
mysql	MySQL
mysql-rds	RDS MySQL
gaussdb-mysql	GaussDB for MySQL
goldendb	GoldenDB
tdsqlx-mysql	TDSQL MySQL (Distributed)
tdsql-mysql	TDSQL MySQL (Centralized)
oceanbase-mysql	OceanBase (MySQL Mode)
oceanbase-oracle	OceanBase (Oracle Mode)
polardbx	PolarDB-X 2.0
postgresql	PostgreSQL
opengauss	OpenGauss
kingbase-es	Kingbase
mogdb	MogDB
gaussdbx	GaussDB (Distributed)
gaussdb-dws	GaussDB for DWS
oracle	Oracle
tdsqlx-pg	TDSQL PostgreSQL (Distributed)
tdsql-pg	TDSQL PostgreSQL (Centralized)
mssql	SQLServer
db2	DB2
dameng	Dameng

POST

/

createWorkspace

A valid request URL is required to generate request examples

{
  "code": 200,
  "message": "Success",
  "data": {
    "workspaceId": "1730508173442965506"
  }
}

授权

userKey

string

header

必填

激活码，通过 /getUserKey 接口获取

请求体

application/json

创建工作空间请求

userKey

string

必填

激活码

示例:

"CB698418-88B25371-67F15F01-XXXXXXXX"

mode

enum<string>

必填

工作空间模式: online（在线）/ offline（离线）

可用选项:

online,

offline

示例:

"offline"

dbType

string

必填

数据库类型 displayCode，支持的值见上方 dbType 表格

示例:

"mysql"

host

string

数据库地址（在线模式必填）

示例:

"localhost"

port

string

数据库端口（在线模式必填）

示例:

"3306"

schemas

string

Schema 列表，逗号分隔，大小写敏感（pg/opengauss/oracle 必填）

database

string

数据库名（在线模式必填）

示例:

"pawsql"

dbUser

string

数据库用户名（在线模式必填）

示例:

"root"

dbPassword

string

数据库密码（在线模式必填）

示例:

"password"

ddlText

string

DDL 文本（离线模式必填）

示例:

"CREATE TABLEorganization(org_idbigint(20) NOT NULL);"

响应

200 - application/json

工作空间创建结果

统一响应体

code

integer

状态码，200 表示成功

示例:

200

message

string

描述信息

示例:

"Success"

data

object

创建工作空间响应

Show child attributes