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

Cleaning Up Temporary Tables of a Lock-Free Change Task

Function

This API is used to clean up temporary tables generated by a lock-free change task of 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/clear

**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
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
task_id	Yes	String	Definition Unique ID of the lock-free change task. To obtain this value, see Querying Lock-Free Change Task Records. Constraints N/A Range N/A Default Value N/A
task_content	Yes	Array of TaskContentItem objects	Definition Details about the lock-free change task, including the target database and temporary table name. Constraints N/A

**Table 4** TaskContentItem
Parameter	Mandatory	Type	Description
schema	Yes	String	Definition Target database of the lock-free change. Constraints N/A Range N/A Default Value N/A
ddl_info	Yes	Array of DDLInfoItem objects	Definition Lock-free change DDL information, including the temporary table name. Constraints N/A

**Table 5** DDLInfoItem
Parameter	Mandatory	Type	Description
table	Yes	String	Definition Temporary table generated during a lock-free change. To obtain this value, see the response parameter temp_table_name in Querying Lock-Free Change Task Records. Constraints N/A 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 cleaning up temporary tables of 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

Cleaning up temporary tables generated by a lock-free change task of an instance

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

{
  "task_id" : "42371a73-a6ec-43e4-89d6-540f492f7e7b",
  "task_content" : [ {
    "schema" : "testdb",
    "ddl_info" : [ {
      "table" : "~test_tb_20250402111436_del"
    } ]
  } ]
}

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