You need to enable JavaScript to run this app.
Database Workshop

Database Workshop

Copy page
Download PDF
Ticket management
CreateDmlSqlChangeTicket
Copy page
Download PDF
CreateDmlSqlChangeTicket
Call the CreateDmlSqlChangeTicket interface to create a DML data change ticket.​
tip​
  • The DML SQL statements to be executed in this interface cannot exceed 1,000 and must not include DDL SQL statements.​
  • This is an asynchronous interface. A ticket ID will be returned upon successful creation. Call the DataDescribeTicketDetail interface to query detailed ticket information.​
  • Pre-checks are required during ticket creation, and the duration depends on the number of SQL statements to be executed.​
Request type​
Asynchronous request.​
Request parameters​
​
Name​
Type​
Required​
Description​
Sample​
InstanceType​
String​
​
Yes​
Database types currently supported are listed below.​
  • MySQL: RDS for MySQL​
  • VeDBMySQL: veDB MySQL​
  • Postgres: RDS for PostgreSQL​
MySQL​
InstanceId​
String​
Yes​
Database instance ID.​
mysql-2579f0******​
SqlText​
​
String​
​
Yes​
Pending DML SQL statements.​
tip​
  • Regular SQL changes can support multiple DML statements, separated by semicolons (;).​
  • Regular SQL changes are suitable for small-scale data modifications and support multiple statements.​
delete from test_table where id = 1;​
​
TicketExecuteType​
​
String​
​
Yes​
​
Work order execution type, with the following values:​
  • Auto: Automatically executes upon approval completion (default).​
  • Manual: Manual execution.​
  • Cron: Scheduled execution.​
Cron​
​
DatabaseName​
String​
Yes​
Database name for the pending ticket.​
db_production​
ExecStartTime​
​
Long​
No​
​
Execution start time, using second timestamp format.​
tip​
When TicketExecuteType is set to Cron, the execution start time must be specified.​
1692508800​
​
ExecEndTime​
Long​
​
No​
Execution end time, using timestamp format in seconds.​
tip​
  • When TicketExecuteType is set to Cron, the execution end time must be specified.​
  • ExecEndTime Must be later than ExecStartTime.​
1692512400​
​
Memo​
​
String​
No​
Ticket remarks. Detailed remarks facilitate future maintenance.​
Create a test table for user data storage.​
Title​
String​
No​
Ticket title.​
Create test table ticket​
​
Response parameters​
​
Name​
Type​
Description​
Sample​
TicketId​
String​
Ticket number​
196490404892248****​
​
Request example​
​
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": "Create a test table for user data storage.", ​
"Title": "Create test table ticket" ​
}​
​
Response example​
​
{​
"ResponseMetadata": {​
"RequestId": "202405101815074D6C61C22FD7E479870C-e62012",​
"Action": "CreateDmlSqlChangeTicket",​
"Version": "2018-01-01",​
"Service": "dbw",​
"Region": "cn-beijing"​
},​
"Result": {​
"TicketId": "196490404892248****"​
}​
}​
​
Error code​
For more details, see Error code.​
Last updated: 2026.03.13 15:40:09