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.
URI
GET /v3/{project_id}/instances/{instance_id}/operation-records
| 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 |
| 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
| 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 Default Value en-us |
Response Parameters
Status code: 200
| 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 |
| 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 | Long | Definition Time when the lock-free change task was created. The value is a 13-digit timestamp in milliseconds. Range N/A |
| ended_at | Long | 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 |
| alter_stage | Integer | Definition Running phase of the lock-free change task at the database kernel layer. Range |
| 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 |
| 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. |
| 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
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error message. |
Status code: 500
| 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
} SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.gaussdb.v3.region.GaussDBRegion; import com.huaweicloud.sdk.gaussdb.v3.*; import com.huaweicloud.sdk.gaussdb.v3.model.*; public class ListOnlineDdlTaskRecordsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); GaussDBClient client = GaussDBClient.newBuilder() .withCredential(auth) .withRegion(GaussDBRegion.valueOf("<YOUR REGION>")) .build(); ListOnlineDdlTaskRecordsRequest request = new ListOnlineDdlTaskRecordsRequest(); request.withInstanceId("{instance_id}"); try { ListOnlineDdlTaskRecordsResponse response = client.listOnlineDdlTaskRecords(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkgaussdb.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = GaussDBClient.new_builder() \ .with_credentials(credentials) \ .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListOnlineDdlTaskRecordsRequest() request.instance_id = "{instance_id}" response = client.list_online_ddl_task_records(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := gaussdb.GaussDBClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := gaussdb.NewGaussDBClient(hcClient) request := &model.ListOnlineDdlTaskRecordsRequest{} request.InstanceId = "{instance_id}" response, err := client.ListOnlineDdlTaskRecords(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Code
For details, see Status Codes.
Error Code
For details, see Error Codes.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot