Querying SQL Insight Tasks

Updated on 2025-03-07 GMT+08:00

View PDF

Function

After SQL Explorer is enabled, you can query SQL Insight tasks. This function is available only for paid instances.

URI

GET /v3/{project_id}/instances/{instance_id}/full-sql-tasks

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Explanation: Project ID of a tenant in a region To obtain this value, see Obtaining a Project ID. Constraints: N/A Values: The value can contain 32 characters. Only letters and digits are allowed. Default value: N/A
instance_id	Yes	String	Explanation: Unique ID of an instance Constraints: N/A Values: The value can contain 32 characters. Only letters and digits are allowed. Default value: N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
range_left	No	Long	Minimum task start and end time in the Unix timestamp format, in milliseconds
range_right	No	Long	Maximum task start and end time in the Unix timestamp format, in milliseconds
create_at_left	No	Long	Minimum task creation time in the Unix timestamp format, in milliseconds
create_at_right	No	Long	Maximum task creation time in the Unix timestamp format, in milliseconds
user	No	String	Username
keyword	No	String	Keyword
db_name	No	String	Database name
operation	No	String	Operation type
thread_id	No	String	Thread ID
trx_id	No	String	Transaction ID
status	No	String	Execution status 0: successful 1: failed
sql_template_id	No	String	SQL template ID
sort_field	No	String	Sorting field create_at: task creation time range_start_at and range_end_at: start time and end time of a task
asc	No	Boolean	Sorting order true: ascending false: descending
page	No	Integer	Page number
limit	No	Integer	Records on each page. The maximum value is 100.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token
X-Language	No	String	Request language type Enumerated values: en-us zh-cn

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
tasks	Array of Table 5 objects	SQL Insight tasks
total	Integer	Total number

**Table 5** FullSqlTask
Parameter	Type	Description
id	Long	Task ID
instance_id	String	Instance ID
instance_name	String	Instance name
node_id	String	Node ID
start_at	Long	Start time in the Unix timestamp format, in milliseconds
end_at	Long	End time in the Unix timestamp format, in milliseconds
batch_id	String	Batch ID
user_list	Array of strings	Username
keyword	Array of strings	Keyword
db_list	Array of strings	Database
operation_list	Array of strings	Operation type
thread_id_list	Array of strings	Thread ID
trx_id_list	Array of strings	Transaction ID
status_list	Array of strings	Execution status 0: successful 1: failed
sql_template_ids	Array of strings	SQL template ID
status	Integer	Task status 0: waiting for parsing 1: parsing 2: parsing completed –1: failed
progress	Double	Task progress. The value ranges from 0 to 100.
reason	String	Failure cause
create_at	Long	Creation time in the Unix timestamp format, in milliseconds
update_at	Long	Update time in the Unix timestamp format, in milliseconds

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code Minimum length: 8 characters Maximum length: 36 characters
error_msg	String	Error message Minimum length: 2 characters Maximum length: 512 characters

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code Minimum length: 8 characters Maximum length: 36 characters
error_msg	String	Error message Minimum length: 2 characters Maximum length: 512 characters

Example Request

GET https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/da304cd5bbb944de828759bc7be3d3fein01/full-sql-tasks

Example Response

Status code: 200

Successful request

{
  "tasks": [
    {
      "id": 1128,
      "instance_id": "da304cd5bbb944de828759bc7be3d3fein01",
      "start_at": 1738717200000,
      "end_at": 1738720800000,
      "status": 2,
      "progress": 100,
      "create_at": 1738740285113,
      "update_at": 1738740294826
    }
  ],
  "total": 1
}