文档首页/ 云数据库 TaurusDB/ API参考/ API/ 无锁变更/ 开启实例无锁变更任务 - StartOnlineDDLTask

更新时间：2026-08-17 GMT+08:00

查看PDF

开启实例无锁变更任务 - StartOnlineDDLTask

功能介绍

开启实例无锁变更任务。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。

如果使用身份策略授权，需具备如下身份策略权限。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
gaussdbformysql:database:modify	Permission_management	instance *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	gaussdb:database:modify	-

URI

POST /v3/{project_id}/instances/{instance_id}/online-ddl-task

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：租户在某一Region下的project ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：只能由英文字母、数字组成，且长度为32个字符。默认取值：不涉及。
instance_id	是	String	参数解释：实例ID，此参数是实例的唯一标识。获取方法请参见查询实例列表。约束限制：不涉及。取值范围：只能由英文字母、数字组成，后缀为in07，长度为36个字符。默认取值：不涉及。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token。通过调用IAM服务获取用户Token接口获取。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
X-Language	否	String	参数解释：请求语言类型。约束限制：不涉及。取值范围： en-us：英文。 zh-cn：中文。默认取值： en-us。
Content-Type	是	String	参数解释：内容类型。约束限制：不涉及。取值范围： application/json。默认值： application/json。

表3 请求Body参数
参数	是否必选	参数类型	描述
auto_clear	否	Boolean	参数解释：是否开启自动清理临时表。约束限制：不涉及。取值范围： true：开启自动清理临时表。 false：关闭自动清理临时表。默认取值： false。
task_content	是	Array of TaskContentItem objects	参数解释：无锁变更任务详细内容。约束限制：不涉及。

表4 TaskContentItem
参数	是否必选	参数类型	描述
schema	是	String	参数解释：无锁变更的目标数据库。获取方法请参见查询数据库列表。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
ddl_info	是	Array of DDLInfoItem objects	参数解释：无锁变更的DDL信息。约束限制：不涉及。

表5 DDLInfoItem
参数	是否必选	参数类型	描述
sql	是	String	参数解释：无锁变更的具体执行SQL。约束限制: 满足ALTER TABLE Statement语法形式，多条SQL需要以英文分号隔开。取值范围：不涉及。默认取值：不涉及。

响应参数

状态码：200

表6 响应Body参数
参数	参数类型	描述
job_id	String	参数解释：工作流ID，开启实例无锁变更任务的工作流标识。取值范围：不涉及。

状态码：400

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误消息。

状态码：500

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误消息。

请求示例

开启实例无锁变更任务。

POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/a23fb62bd61e4e9e9636fd2225f395bein07/online-ddl-task

{
  "auto_clear" : true,
  "task_content" : [ {
    "schema" : "testdb",
    "ddl_info" : [ {
      "sql" : "Alter table test_tb add name varchar(11);"
    } ]
  } ]
}

批量开启实例无锁变更任务。

POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/a23fb62bd61e4e9e9636fd2225f395bein07/online-ddl-task

{
  "auto_clear" : true,
  "task_content" : [ {
    "schema" : "testdb",
    "ddl_info" : [ {
      "sql" : "Alter table test_tb1 add name varchar(11); Alter table test_tb2 add age varchar(11);"
    } ]
  } ]
}

响应示例

状态码：200

Success.

{
  "job_id" : "42371a73-a6ec-43e4-89d6-540f492f7e7b"
}

状态码

状态码	描述
200	Success.
400	Client error.
500	Server error.

错误码

请参见错误码。

父主题：无锁变更

上一篇：无锁变更

下一篇：停止实例无锁变更任务 - StopOnlineDDLTask