Help Center/ TaurusDB/ API Reference/ APIs/ Lock-Free Change/ Enabling a Lock-Free Change Task for an Instance

Updated on 2026-08-31 GMT+08:00

View PDF

Enabling a Lock-Free Change Task for an Instance

Function

This API is used to enable a lock-free change task for an instance. Before calling this API:

Learn how to authenticate it.
Obtain the required region and endpoint.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependency
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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. To obtain this value, see Querying DB Instances. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
Content-Type	Yes	String	Definition Content type. Constraints N/A Range application/json Default Value application/json
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us: English zh-cn: Chinese Default Value en-us

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
auto_clear	No	Boolean	Definition Whether to enable automatic temporary table cleanup. Constraints N/A Range true: Automatic temporary table cleanup is enabled. false: Automatic temporary table cleanup is disabled. Default Value false
task_content	Yes	Array of TaskContentItem objects	Definition Details about the lock-free change task. Constraints N/A

**Table 4** TaskContentItem
Parameter	Mandatory	Type	Description
schema	Yes	String	Definition Target database of the lock-free change. To obtain this value, see Querying Databases. Constraints N/A Range N/A Default Value N/A
ddl_info	Yes	Array of DDLInfoItem objects	Definition Lock-free change DDL. Constraints N/A

**Table 5** DDLInfoItem
Parameter	Mandatory	Type	Description
sql	Yes	String	Definition SQL statement to be executed for the lock-free change. Constraints The value must comply with the ALTER TABLE statement syntax. Separate multiple SQL statements with semicolons (;). Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 6** Response body parameters
Parameter	Type	Description
job_id	String	Definition ID of the workflow for enabling the lock-free change task. Range N/A

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Enabling a lock-free change task for an instance

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);"
    } ]
  } ]
}

Batch enabling lock-free change tasks for an instance

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);"
    } ]
  } ]
}

Example Response

Status code: 200

Success.

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

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent Topic: Lock-Free Change

Previous topic: Lock-Free Change

Next topic: Stopping a Lock-Free Change Task of an Instance