Help Center/ TaurusDB/ API Reference/ APIs/ Lock-Free Change/ Querying Lock-Free Change Task Records

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

View PDF

Querying Lock-Free Change Task Records

Function

This API is used to query lock-free change task records. 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:list	List	instance *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	gaussdb:instance:list gaussdb:database:list	-

URI

GET /v3/{project_id}/instances/{instance_id}/operation-records

**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

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Definition Number of records returned by a query. Constraints The value must be an integer and cannot be a negative number. Range 1–100 Default Value 10
offset	No	Integer	Definition Index offset. The query starts from the next piece of data indexed by this parameter. Constraints The value must be an integer and cannot be a negative number. Range ≥ 0 Default Value 0
start_time	No	String	Definition Start timestamp of the query. The value is a UNIX timestamp, in milliseconds. The time zone is the standard UTC time zone. When specifying the parameter, first convert the time from your local time zone to a UTC timestamp. For example, for a time in the Beijing time zone (UTC+08:00), subtract 8 hours to get the UTC timestamp. Constraints N/A Range The value contains 13 characters. Only digits are allowed. Default Value N/A
end_time	No	String	Definition End timestamp of the query. The value is a UNIX timestamp, in milliseconds. The time zone is the standard UTC time zone. When specifying the parameter, first convert the time from your local time zone to a UTC timestamp. For example, for a time in the Beijing time zone (UTC+08:00), subtract 8 hours to get the UTC timestamp. Constraints N/A Range The value contains 13 characters. Only digits are allowed. Default Value N/A

Request Parameters

**Table 3** 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

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
records	Array of RecordItem objects	Definition List of lock-free change task details.
total_count	Integer	Definition Total number of lock-free change task records. The value is an integer. Range ≥ 0

**Table 5** RecordItem
Parameter	Type	Description
task_id	String	Definition ID of a lock-free change task record. Range N/A
task_content	Array of TaskContentItem objects	Definition Details about the lock-free change task.
created_at	Integer	Definition Time when the lock-free change task was created. The value is a 13-digit timestamp in milliseconds. Range N/A
ended_at	Integer	Definition End time of the lock-free change task. The value is a 13-digit timestamp in milliseconds. Range N/A
task_status	String	Definition Execution status of the lock-free change task. Range checking: The pre-check is being performed. check successful: The pre-check is successful. check failed: The pre-check failed. altering: The change is being performed. alter successful: The change is successful. alter failed: The change failed. stopping: The task is being stopped. stop successful: The task is stopped successfully. stop failed: The task failed to be stopped. cleaning: Temporary tables are being cleaned up. clean successful: Temporary tables are cleaned up successfully. clean failed: Temporary tables failed to be cleaned up.
alter_stage	Integer	Definition Running phase of the lock-free change task at the database kernel layer. Range 0: The lock-free change task has not started. 1: Resource initialization is complete for the lock-free change task. 2: The lock-free change task is running. 3: The lock-free change task is complete.
percentage	Float	Definition Progress (%) of the lock-free change task. The value is accurate to one decimal place. Range 0.0–100.0
error_reason	String	Definition Failure cause of the lock-free change task. A value is returned when the task fails to be executed. Range N/A
temp_table_name	String	Definition Name of the temporary table for the lock-free change task. A value is returned when automatic temporary table cleanup is disabled. Range N/A

**Table 6** TaskContentItem
Parameter	Type	Description
schema	String	Definition Target database of the lock-free change. Range N/A
ddl_info	Array of DDLInfoItem objects	Definition Lock-free change DDL.

**Table 7** DDLInfoItem
Parameter	Type	Description
table	String	Definition Target table of lock-free change. Range N/A
sql	String	Definition SQL statement to be executed for the lock-free change. Range N/A

Status code: 400

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

Status code: 500

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

Example Request

Querying lock-free change task records of an instance

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/a23fb62bd61e4e9e9636fd2225f395bein07/operation-records?offset=0&limit=10&start_time=1774972800000&end_time=1775750399000

Example Response

Status code: 200

Success.

{
  "records" : [ {
    "task_id" : "42371a73-a6ec-43e4-89d6-540f492f7e7b",
    "task_content" : [ {
      "schema" : "testdb",
      "ddl_info" : [ {
        "table" : "test_tb",
        "sql" : "Alter table test_tb add name varchar(11)"
      } ]
    } ],
    "created_at" : 1743563656172,
    "ended_at" : 1743563683552,
    "task_status" : "alter successful",
    "alter_stage" : 3,
    "percentage" : 100,
    "error_reason" : "XXX",
    "temp_table_name" : "~test_tb_20250402111436_del"
  } ],
  "total_count" : 1
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent Topic: Lock-Free Change

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

Next topic: Obtaining the Download Link of the Log Records of a Lock-Free Change Task