Skip to main content
POST
Error

授权

​
userKey
string
header
必填

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

请求体

application/json

创建优化任务请求

​
userKey
string
必填

激活码

示例:

"CB698418-88B25371-67F15F01-XXXXXXXX"

​
workspace
string
必填

工作空间 ID 或 DDL 文本（传入 DDL 时自动创建离线工作空间）

​
workload
string
必填

待优化的 SQL 文本

​
queryMode
enum<string>
必填

SQL 类型: plain_sql / mysql_query_log / postgresql_query_log

可用选项:
plain_sql,
mysql_query_log,
postgresql_query_log
示例:

"plain_sql"

​
dbType
string

数据库类型（displayCode），当 workspace 为 DDL 时必填，默认 mysql。 支持的 dbType 值见 /createWorkspace 接口的 dbType 表格。

​
validateFlag
boolean
默认值:false

是否执行 validate 校验（仅在线工作空间生效），默认 false

​
singleQueryFlag
boolean

是否校验仅单条 SQL

​
analysisName
string

优化任务名称，不填则自动生成

​
analyzeFlag
boolean

是否执行分析

​
closeRewrite
boolean

是否关闭查询重写

​
deduplicateFlag
boolean

是否去重索引

​
updateStatsBeforeValidationFlag
boolean

validate 前是否更新统计信息

​
indexOnly
boolean

是否仅推荐索引（不重写）

​
maxMembers
integer

复合索引最大列数

​
maxMembersForIndexOnly
integer

index-only 模式复合索引最大列数

​
maxPerTable
integer

每张表最大推荐索引数

​
maxSpace
integer

最大索引空间倍数

​
rules
object[]

自定义规则列表，不填则使用默认审计规则

响应

200 - application/json

异步优化任务创建结果

统一响应体

​
code
integer

状态码，200 表示成功

示例:

200

​
message
string

描述信息

示例:

"Success"

​
data
object

创建优化任务响应