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

数据库工作台

复制全文
下载 pdf
工单管理
CreateDmlSqlChangeTicket
复制全文
下载 pdf
CreateDmlSqlChangeTicket
调用 CreateDmlSqlChangeTicket 接口创建 DML 数据变更工单。​
说明​
  • 此接口中待执行的 DML SQL 语句不能超过 1000 条,且不能包含 DDL SQL 语句。​
  • 该接口为异步接口,工单创建成功后会返回一个工单 ID。调用 DescribeTicketDetail 接口可以查询工单的详细信息。​
  • 创建工单时需要进行预检查,预检查的耗时和待执行的 SQL 语句数量相关。​
请求类型​
异步请求。​
请求参数​
​
名称​
类型​
是否必选​
描述​
示例值​
InstanceType​
String​
​
是​
数据库类型,当前支持的数据库如下所示。​
  • MySQL:云数据库 MySQL 版。​
  • VeDBMySQL:云数据库 veDB MySQL 版。​
  • Postgres:云数据库 PostgresSQL 版。​
MySQL​
InstanceId​
String​
是​
数据库实例 ID。​
mysql-2579f0******​
SqlText​
​
String​
​
是​
待执行的 DML SQL 语句。​
说明​
  • 普通 SQL 变更可以支持多条 DML 语句,多条 SQL 语句间用英文分号(;)隔开。​
  • 普通 SQL 变更,适用于少量数据变更场景,支持多条语句。​
delete from test_table where id = 1;​
​
TicketExecuteType​
​
String​
​
是​
​
工单执行类型,取值如下: ​
  • Auto:(默认值)审批完成自动执行。​
  • Manual:手动执行。​
  • Cron:定时执行。​
Auto​
​
DatabaseName​
String​
是​
待执行工单的数据库名称。​
db_production​
ExecStartTime​
​
Long​
否​
​
执行开始时间,使用秒时间戳格式。​
说明​
当 TicketExecuteType 设置为 Cron 时,需要指定执行开始时间。​
1692508800​
​
ExecEndTime​
Long​
​
否​
执行结束时间,使用秒时间戳格式。​
说明​
  • 当 TicketExecuteType 设置为 Cron 时,需要指定执行结束时间。​
  • ExecEndTime 需晚于 ExecStartTime。​
1692512400​
​
Memo​
​
String​
否​
工单备注信息。详实的备注信息有利于后期维护。​
创建测试表,用于用户数据存储。​
Title​
String​
否​
工单标题。​
创建测试表工单​
​
返回参数​
​
名称​
类型​
描述​
示例值​
TicketId​
String​
工单号​
196490404892248****​
​
请求示例​
​
POST /?Action=CreateDmlSqlChangeTicket&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****​
​
{​
"InstanceType": "MySQL", ​
"InstanceId": "mysql-2579f0******", ​
"SqlText": "delete from test_table where id = 1", ​
"TicketExecuteType": "Cron", ​
"DatabaseName": "db_production", ​
"ExecStartTime": 1692508800, ​
"ExecEndTime": 1692512400, ​
"Memo": "创建测试表,用于用户数据存储", ​
"Title": "创建测试表工单" ​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "202405101815074D6C61C22FD7E479870C-e62012",​
"Action": "CreateDmlSqlChangeTicket",​
"Version": "2018-01-01",​
"Service": "dbw",​
"Region": "cn-beijing"​
},​
"Result": {​
"TicketId": "196490404892248****"​
}​
}​
​
错误码​
更多详情,请参见错误码。​
最近更新时间:2026.02.12 15:46:14
这个页面对您有帮助吗?
有用
有用
无用
无用