文档中心

数据库工作台

工单管理

CreateDdlSqlChangeTicket

调用 CreateDdlSqlChangeTicket 接口创建 DDL 结构变更工单。

说明

目前只支持调用此接口为 MySQL、VeDBMySQL 和 Postgres 类型的数据库创建 DDL 工单。其中 MySQL 和 VeDBMySQL 类型的数据库默认会创建无锁结构变更工单，且只能执行一条 DDL SQL 语句；Postgres 类型的数据库目前是直接执行 DDL SQL 语句，且一次最多可执行 10 条 DDL SQL 语句。

Postgres 类型的数据库执行 ALTER SQL 语句时，可能会导致锁表。

该接口为异步接口，工单创建成功后会返回一个工单 ID。调用 DescribeTicketDetail 接口可以查询工单的详细信息。

创建工单时需要进行预检查，预检查的耗时和待执行的 SQL 语句数量相关。

请求类型

异步请求。

请求参数

名称	类型	是否必选	描述	示例值
InstanceType	String	是	数据库类型，当前支持的数据库如下所示。 MySQL：云数据库 MySQL 版。 VeDBMySQL：云数据库 veDB MySQL 版。 Postgres：云数据库 PostgresSQL 版。	MySQL
InstanceId	String	是	数据库实例 ID。	mysql-2579f0******
SqlText	String	是	待执行的 DDL SQL 语句。说明普通 SQL 变更可以下发多条 DDL 语句，多条 SQL 语句间用英文分号（;）隔开。注意 DDL 有锁表风险，建议选择无锁结构变更逐条提交。	CREATE TABLE test (id INT PRIMARY KEY)
TicketExecuteType	String	是	工单执行类型，枚举值： Auto：审批完成自动执行，默认值。 Manual：手动执行。 Cron：定时执行。	Cron
DatabaseName	String	是	待执行工单的数据库名称。	db_production
ExecStartTime	Long	否	执行开始时间，使用秒时间戳格式。说明当 TicketExecuteType 设置为 Cron 时，需要指定执行开始时间。	1692508800
ExecEndTime	Long	否	执行结束时间，使用秒时间戳格式。说明当 TicketExecuteType 设置为 Cron 时，需要指定执行结束时间。 ExecEndTime 需晚于 ExecStartTime。	1692512400
Memo	String	否	工单备注信息。详实的备注信息有利于后期维护。	创建测试表，用于用户数据存储。
Title	String	否	工单标题。	创建测试表工单

返回参数

名称	类型	描述	示例值
TicketId	String	工单 ID。	178887541272244****

请求示例

POST /?Action=CreateDdlSqlChangeTicket&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-123456",  ​
  "SqlText": "CREATE TABLE test (id INT PRIMARY KEY)",  ​
  "TicketExecuteType": "Cron",  ​
  "DatabaseName": "db_production",  ​
  "ExecStartTime": 1692508800,  ​
  "ExecEndTime": 1692512400,  ​
  "Memo": "创建测试表用于用户数据存储",  ​
  "Title": "创建测试表工单" ​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "202405101815074D6C61C22FD7E479870C-e62012",​
        "Action": "CreateDdlSqlChangeTicket",​
        "Version": "2018-01-01",​
        "Service": "dbw",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "TicketId": "178887541272244****"​
    }​
}​

错误码

更多详情，请参见错误码。

最近更新时间：2026.02.12 15:46:47

这个页面对您有帮助吗？

有用

无用