创建审核任务 - PawSQL

A valid request URL is required to generate request examples

{
  "code": 200,
  "message": "Success",
  "data": {
    "taskId": "audit-001",
    "status": "accepted",
    "result": null
  }
}

{
  "code": 400,
  "message": "工作空间ID不能为空",
  "data": null
}

POST

/

sql-audits

A valid request URL is required to generate request examples

{
  "code": 200,
  "message": "Success",
  "data": {
    "taskId": "audit-001",
    "status": "accepted",
    "result": null
  }
}

{
  "code": 400,
  "message": "工作空间ID不能为空",
  "data": null
}

请求体

application/json

创建SQL审核任务请求

sqlSource

object

必填

SQL来源配置

Show child attributes

workspaceId

string

必填

工作空间ID

示例:

"1730411624641736706"

ruleTemplateId

string

必填

审核模板ID

示例:

"100"

platformCode

string

必填

平台实例标识（如 blueking-prod, coding-prod）

示例:

"blueking-prod"

requestId

string

幂等键（外部请求ID，可选。为空时不检查幂等性，每次都执行审核）

dbVersion

string

数据库版本

operatorEmail

string

操作人邮箱（可选。传入时以该用户身份创建审核任务）

enableIndexRecommendation

boolean

默认值:true

是否执行索引推荐，默认true；传false时仅审核不做索引推荐

platformType

string

平台类型: blueking/coding（可选，用于明确指定来源平台）

extra

object

扩展数据（透传到结果中）

响应

审核任务创建成功

SQL审核任务响应

taskId

string

任务ID

requestId

string

幂等键（外部请求ID）

status

enum<string>

任务状态: accepted/running/finished

可用选项:

accepted,

running,

finished

result

enum<string>

判定结果: allow/deny/timeout/failed

可用选项:

allow,

deny,

timeout,

failed

errorCode

integer

错误码（仅当result=failed时有值）

errorMessage

string

错误信息（仅当result=failed时有值）

riskLevel

enum<integer>

风险等级: 0-critical 1-warning 2-notice

可用选项:

0,

1,

2

riskLevelDesc

enum<string>

风险等级描述: critical/warning/notice

可用选项:

critical,

warning,

notice

statistics

object

统计信息

summary

string

审核摘要（Markdown格式，适合展示）

summaryData

object

审核摘要（结构化JSON，适合度量分析）

Show child attributes

reportUrl

string

报告详情页URL

reportHtml

string

报告HTML内容

callbackStatus

string

回调状态: pending/success/failed/skipped

callbackMessage

string

回调结果信息

finishedAt

string<date-time>

完成时间

extra

object

扩展数据（透传）

ticketId

string

关联的工单ID

ticketTitle

string

工单标题（可用于平台搜索）

auditId

string

关联的审核ID

workspaceInfo

object

工作空间信息

Show child attributes

env

string

环境信息

orgInfo

object

机构信息

Show child attributes

ruleTemplateInfo

object

规则模板信息

Show child attributes

operatorEmail

string

操作人邮箱

enableIndexRecommendation

boolean

是否执行索引推荐