You need to enable JavaScript to run this app.
文档中心
数据库工作台

数据库工作台

复制全文
下载 pdf
工单管理
DescribePreCheckDetail
复制全文
下载 pdf
DescribePreCheckDetail
调用 DescribePreCheckDetail 接口查询工单的预检查结果。​
请求类型​
同步请求。​
请求参数​
​
名称​
类型​
是否必选​
描述​
示例值​
TicketId​
String​
​
是​
工单 ID。​
2013522829558******​
​
​
返回参数​
当返回参数 AllPass、EnableSubmitTicket 和 PrecheckFinished 的取值均为 true 时,表明预检查通过。​
​
名称​
类型​
描述​
示例值​
AllPass​
Boolen​
当前操作是否通过了所有预设的检查规则,取值如下:​
  • true:表示所有预设的检查规则全部通过。​
  • false:表示存在预设的检查规则未通过。​
true​
EnableSubmitTicket​
Boolen​
是否成功提交工单,取值如下:​
  • true:表示提交工单成功。​
  • false:表示提交工单失败。​
true​
IsContainDDL​
Boolen​
预检查的 SQL 语句中是否包含 DDL,取值如下:​
  • true:表示 SQL 语句中含有 DDL,例如 CREATE、ALTER、DROP 等。​
  • false:表示 SQL 语句中仅包含 DML,例如 SELECT、INSERT、UPDATE、DELETE。​
true​
PreCheckDetails​
Array of string​
预检查项详情。详细信息,请参见 PreCheckDetailes。​
​
[​
{​
"IsItemCanBeIgnore": false,​
"IsItemIgnored": false,​
"ItemDetails": [​
{​
"Result": "0",​
"SQL": "INSERT INTO `tb1` (name, age, phone) VALUES ('王五', 28, '13800138000');"​
},​
{​
"Result": "0",​
"SQL": "INSERT INTO `tb1` (name, age, phone) VALUES ('张三', 28, '13800138001');"​
},​
{​
"Result": "0",​
"SQL": "INSERT INTO `tb1` (name, age, phone) VALUES ('张三', 28, '138001380022');"​
},​
{​
"Result": "0",​
"SQL": "INSERT INTO `tb1` (name, age, phone) VALUES ('张三', 28, '13800138003');"​
}​
],​
"ItemName": "影响行数(系统统计值,实际影响行数仍然以SQL执行为准!)",​
"PreCheckItem": "Explain",​
"PreCheckState": "Success",​
"Result": "0"​
}​
]​
​
PrecheckFinished​
Boolen​
系统是否已对 SQL 语句完成所有预检查,取值如下:​
  • true:表示系统已对 SQL 语句完成所有预检查(如语法、权限、性能、安全等),并生成了检查结果,预检查结果的详细信息,请参见 PreCheckDetails。​
  • false:表示系统暂未对 SQL 语句完成所有预检查,包括预检查尚未开始、正在进行中或因异常中断。​
true​
Step​
Integer​
表示当前操作所处的流程阶段或执行步骤编号。​
6​
TicketId​
String​
工单 ID。​
2013522829558******​
TotalNeedCheck​
Integer​
当前工单需要执行的预检查项总数。​
6​
​
请求示例​
​
POST /?Action=DescribePreCheckDetail&Version=2018-01-01 HTTP/1.1​
Content-Type: application/json​
Host: dbw.cn-beijing.volcengineapi.com​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/dbw/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****​
​
{​
"TicketId": "2013522829558******"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20260225105133E397870590FACAD82A4E-f162e3",​
"Action": "DescribePreCheckDetail",​
"Version": "2018-01-01",​
"Service": "dbw",​
"Region": "cn-beijing"​
},​
"Result": {​
"AllPass": true,​
"EnableSubmitTicket": true,​
"IsContainDDL": false,​
"PreCheckDetails": [​
{​
"IsItemCanBeIgnore": false,​
"IsItemIgnored": false,​
"ItemDetails": [​
{​
"Result": "0",​
"SQL": "INSERT INTO `tb1` (name, age, phone) VALUES ('王五', 28, '13800138000');"​
},​
{​
"Result": "0",​
"SQL": "INSERT INTO `tb1` (name, age, phone) VALUES ('张三', 28, '13800138001');"​
},​
{​
"Result": "0",​
"SQL": "INSERT INTO `tb1` (name, age, phone) VALUES ('张三', 28, '138001380022');"​
},​
{​
"Result": "0",​
"SQL": "INSERT INTO `tb1` (name, age, phone) VALUES ('张三', 28, '13800138003');"​
}​
],​
"ItemName": "影响行数(系统统计值,实际影响行数仍然以SQL执行为准!)",​
"PreCheckItem": "Explain",​
"PreCheckState": "Success",​
"Result": "0"​
},​
{​
"IsItemCanBeIgnore": false,​
"IsItemIgnored": false,​
"ItemDetails": [​
{​
"Result": "Pass",​
"SQL": "INSERT INTO `tb1` (name, age, phone) VALUES ('王五', 28, '13800138000');"​
},​
{​
"Result": "Pass",​
"SQL": "INSERT INTO `tb1` (name, age, phone) VALUES ('张三', 28, '13800138001');"​
},​
{​
"Result": "Pass",​
"SQL": "INSERT INTO `tb1` (name, age, phone) VALUES ('张三', 28, '138001380022');"​
},​
{​
"Result": "Pass",​
"SQL": "INSERT INTO `tb1` (name, age, phone) VALUES ('张三', 28, '13800138003');"​
}​
],​
"ItemName": "语法检查",​
"PreCheckItem": "Syntax",​
"PreCheckState": "Success",​
"Result": "Pass"​
},​
{​
"IsItemCanBeIgnore": false,​
"IsItemIgnored": false,​
"ItemDetails": [​
{​
"Result": "Pass",​
"SQL": "INSERT INTO `tb1` (name, age, phone) VALUES ('王五', 28, '13800138000');"​
},​
{​
"Result": "Pass",​
"SQL": "INSERT INTO `tb1` (name, age, phone) VALUES ('张三', 28, '13800138001');"​
},​
{​
"Result": "Pass",​
"SQL": "INSERT INTO `tb1` (name, age, phone) VALUES ('张三', 28, '138001380022');"​
},​
{​
"Result": "Pass",​
"SQL": "INSERT INTO `tb1` (name, age, phone) VALUES ('张三', 28, '13800138003');"​
}​
],​
"ItemName": "权限检查",​
"PreCheckItem": "Permission",​
"PreCheckState": "Success",​
"Result": "Pass"​
},​
{​
"IsItemCanBeIgnore": false,​
"IsItemIgnored": false,​
"ItemDetails": [​
{​
"Result": "",​
"SQL": "INSERT INTO `tb1` (name, age, phone) VALUES ('王五', 28, '13800138000');"​
},​
{​
"Result": "",​
"SQL": "INSERT INTO `tb1` (name, age, phone) VALUES ('张三', 28, '13800138001');"​
},​
{​
"Result": "",​
"SQL": "INSERT INTO `tb1` (name, age, phone) VALUES ('张三', 28, '138001380022');"​
},​
{​
"Result": "",​
"SQL": "INSERT INTO `tb1` (name, age, phone) VALUES ('张三', 28, '13800138003');"​
}​
],​
"ItemName": "安全规则检查",​
"PreCheckItem": "SecurityRule",​
"PreCheckState": "Success",​
"Result": "Pass"​
},​
{​
"IsItemCanBeIgnore": false,​
"IsItemIgnored": false,​
"ItemDetails": [​
{​
"Result": "Instance Status is Running",​
"SQL": "INSERT INTO `tb1` (name, age, phone) VALUES ('王五', 28, '13800138000');"​
},​
{​
"Result": "Instance Status is Running",​
"SQL": "INSERT INTO `tb1` (name, age, phone) VALUES ('张三', 28, '13800138001');"​
},​
{​
"Result": "Instance Status is Running",​
"SQL": "INSERT INTO `tb1` (name, age, phone) VALUES ('张三', 28, '138001380022');"​
},​
{​
"Result": "Instance Status is Running",​
"SQL": "INSERT INTO `tb1` (name, age, phone) VALUES ('张三', 28, '13800138003');"​
}​
],​
"ItemName": "实例状态检查",​
"PreCheckItem": "Instance",​
"PreCheckState": "Success",​
"Result": "Instance Status is Running"​
},​
{​
"IsItemCanBeIgnore": true,​
"IsItemIgnored": false,​
"ItemDetails": [​
{​
"Result": "Pass",​
"SQL": "INSERT INTO `tb1` (name, age, phone) VALUES ('王五', 28, '13800138000');"​
},​
{​
"Result": "Pass",​
"SQL": "INSERT INTO `tb1` (name, age, phone) VALUES ('张三', 28, '13800138001');"​
},​
{​
"Result": "Pass",​
"SQL": "INSERT INTO `tb1` (name, age, phone) VALUES ('张三', 28, '138001380022');"​
},​
{​
"Result": "Pass",​
"SQL": "INSERT INTO `tb1` (name, age, phone) VALUES ('张三', 28, '13800138003');"​
}​
],​
"ItemName": "参数检查",​
"PreCheckItem": "Param",​
"PreCheckState": "Success",​
"Result": "Pass"​
}​
],​
"PrecheckFinished": true,​
"Step": 6,​
"TicketId": "2013522829558******",​
"TotalNeedCheck": 6​
}​
}​
​
错误码​
更多详情,请参见错误码。​
最近更新时间:2026.03.11 16:32:20
这个页面对您有帮助吗?
有用
有用
无用
无用