Create workspace

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

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

Authorizations

userKey

string

header

required

Activation code, obtained via the /getUserKey endpoint

Body

application/json

Create workspace request

userKey

string

required

Activation code

Example:

"CB698418-88B25371-67F15F01-XXXXXXXX"

mode

enum<string>

required

Workspace mode: online / offline

Available options:

online,

offline

Example:

"offline"

dbType

string

required

Database type displayCode, see the dbType table above for supported values

Example:

"mysql"

host

string

Database host (required in online mode)

Example:

"localhost"

port

string

Database port (required in online mode)

Example:

"3306"

schemas

string

Schema list, comma-separated, case-sensitive (required for pg/opengauss/oracle)

database

string

Database name (required in online mode)

Example:

"pawsql"

dbUser

string

Database username (required in online mode)

Example:

"root"

dbPassword

string

Database password (required in online mode)

Example:

"password"

ddlText

string

DDL text (required in offline mode)

Example:

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

Response

200 - application/json

Workspace creation result

Unified response body

code

integer

Status code, 200 indicates success

Example:

200

message

string

Description message

Example:

"Success"

data

object

Create workspace response

Show child attributes

CD/CD Integration

SQL Optimization

Create workspace

Supported dbType values

Authorizations

Body

Response