Query offline task details with DescribeSqlLogTask - Database Autonomy Service - Alibaba Cloud - Database Autonomy Service

Queries the details of a DAS Enterprise Edition batch task by calling the DescribeSqlLogTask operation.

Operation description

Before you begin:

Use the latest version of the Alibaba Cloud or DAS SDK.
When calling DAS by using the SDK, set the region to cn-shanghai.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hdm:DescribeSqlLogTask

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The database instance ID.	r-bp1nti25tc7bq5****
TaskId	string	No	The task ID.	a4f5c4494dbd6713185d87a97aa53e8
PageNo	integer	No	The page number for the paging query. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The maximum number of records per page for the paging query. Maximum value: 100. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object	The root node or root directory.
Code	string	The returned status code.	200
Message	string	The returned message. Note If the request is successful, Successful is returned. If the request fails, exception information such as an error code is returned.	Successful
RequestId	string	The request ID.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	Indicates whether the request is successful. true: The request is successful. false: The request fails.	true
Data	object	The returned data.
Name	string	The task name.	SQL audit export 1
TaskId	string	The task ID.	9a4f5c4494dbd6713185d87a97aa53e8
TaskType	string	The task type. Valid values: Export: export task. Query: custom query task.	Query
CreateTime	integer	The task creation time. The value is a UNIX timestamp in milliseconds.	1681363254423
Status	string	The task status. Valid values: INIT: Pending scheduling. RUNNING: Running. FAILED: Failed. CANCELED: Canceled. COMPLETED: Completed. Note When the task is in the COMPLETED state, you can view the results of the offline task.	COMPLETED
Expire	boolean	Indicates whether the task has expired. true: The task has expired. false: The task has not expired.	false
Start	integer	The query start time. The value is a UNIX timestamp in milliseconds.	1596177993000
End	integer	The query end time. The value is a UNIX timestamp in milliseconds.	1608888296000
Filters	array<object>	The filter conditions.
	object	The query filter condition.
Key	string	The name of the filter parameter. Note For supported filter parameters and their values, refer to Supplementary description of response parameters.	keyWords
Value	any	The value of the filter parameter.	select
Total	integer	The total number of tasks.	1
Queries	array<object>	The task result of the offline query node. This value is returned only when TaskType is set to Query.
	object	The task result of the offline query node.
Vip	string	The endpoint resolution address of the query link.	10.146.XX.XX
NodeId	string	The child node ID.	pi-bp1o58x3ib7e6****
SqlText	string	The SQL statement details.	SELECT @@session.transaction_read_only
SqlType	string	The type of the SQL statement. Valid values: SELECT UPDATE DELETE	SELECT
State	string	The execution result. 0: Execution succeeded. 1: Execution failed.	0
DBName	string	The database name.	testdb01
SqlId	string	SQL ID。	a4111670e80596c5bf42cf5154438a91
ExecuteTime	string	The execution time in UTC format: `yyyy-MM-ddTHH:mm:ssZ`.	2023-12-07T02:15:32Z
OriginTime	integer	The execution timestamp. The value is a UNIX timestamp in milliseconds.	1701886532000
AccountName	string	The database account.	testname
HostAddress	string	The client IP address.	11.197.XX.XX
Consume	integer	The execution duration in milliseconds.	58
LockTime	integer	The lock wait time in milliseconds.	0
UpdateRows	integer	The number of updated rows.	0
ScanRows	integer	The number of scanned rows.	0
ReturnRows	integer	The number of returned rows.	0
LogicRead	integer	The number of logical reads.	0
PhysicSyncRead	integer	The number of physical synchronous reads.	0
PhysicAsyncRead	integer	The number of physical asynchronous reads.	0
ThreadId	integer	The thread ID.	None
TrxId	string	The transaction ID.	200000
Ext	string	The extended information field. This is a reserved parameter.	None
Scnt	integer	The number of DN requests from the PolarDB-X 2.0 compute node (CN).	10
Rows	integer	The total number of rows updated or returned by the PolarDB-X 2.0 compute node.	10
Frows	integer	The number of rows fetched by the PolarDB-X 2.0 compute node (CN).	10
TraceId	string	The trace ID of PolarDB-X 2.0, which is the execution ID of the SQL statement on the data node.	14c93b7c7bf00000
UseImciEngine	string	Indicates whether the PolarDB for MySQL instance uses the In-Memory Column Index. true: The IMCI is used. false: The IMCI is not used.	true
ParallelDegree	string	The parallel queue time of the PolarDB for MySQL instance in milliseconds.	10
ParallelQueueTime	string	The parallel degree of the PolarDB for MySQL instance.	2
PhysicRead	integer	The number of physical reads.	0
CpuTime	integer	The CPU execution time in microseconds.	100
Writes	integer	The number of writes for the RDS SQL Server engine.	10
Collection	string	A reserved parameter.	None
SqlCommand	integer	The SQL command in the query.	sql
ConnectionId	string	The connection ID used in the query.	ld-******
Protected	string	Indicates whether the query item is protected.	MySQL
Params	string	The list of query parameters.	[1, "das"]
ClientIp	string	The client IP address in the query.	10.0.0.1xx
ClientPort	integer	The client port number in the query.	3306
RowKey	string	The row key in the query.	23
AffectColumns	string	The affected columns.	["col1"]
TableName	string	The table name used in the query.	das
Export	string	The download URL of the export task. This value is returned only when TaskType is set to Export.	"https://das-sqllog-download-cn-hongkong.oss-cn-hongkong.aliyuncs.com/****"

Key supports the following parameters and values:

KeyWords: The keywords. Separate multiple keywords with spaces.
LogicalOperator: The logical operator between keywords. Valid values: and or or.
AccountName: The username. You can specify multiple usernames separated by commas. The maximum number is 5.
dbName: The database name. You can specify multiple database names separated by commas. The maximum number is 5.
HostAddress: The client IP address. You can specify multiple IP addresses separated by commas. The maximum number is 5.
MaxConsume: The maximum execution duration. Unit: us.
MinConsume: The minimum execution duration. Unit: us.
MaxScanRows: The maximum number of scanned rows.
MinScanRows: The minimum number of scanned rows.
SqlType: The SQL type. Valid values: select, update, insert, or delete.
State: The execution result. Valid values: 0 (success) or 1 (failure).
ThreadId: The thread ID.
SortKey: The name of the sort column. Valid values: ScanRows (number of scanned rows), UpdateRows (number of updated rows), Consume (execution duration), ExecuteTime (execution time), ReturnRows (number of returned rows), LockTime (lock wait time), Frows (number of rows fetched by PolarDB-X 2.0 compute nodes), Scnt (number of DN requests from PolarDB-X 2.0 compute nodes), CpuTime (CPU execution time), or PhysicalRead (physical reads).
SortMethod: The sort order. Valid values: DESC (descending) or ASC (ascending). Default value: DESC.
TraceId: The trace ID of the PolarDB-X 2.0 instance.
MinRows: The minimum number of updated rows.
MaxRows: The maximum number of updated rows.
MinScnt: The minimum number of DN requests from PolarDB-X 2.0 compute nodes (CN).
MaxScnt: The maximum number of DN requests from PolarDB-X 2.0 compute nodes (CN).
TrxId: The transaction ID.
Fail: The error code.
SqlId: The SQL ID.

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true",
  "Data": {
    "Name": "SQL audit export 1",
    "TaskId": "9a4f5c4494dbd6713185d87a97aa53e8\n",
    "TaskType": "Query",
    "CreateTime": 1681363254423,
    "Status": "COMPLETED",
    "Expire": true,
    "Start": 1596177993000,
    "End": 1608888296000,
    "Filters": [
      {
        "Key": "keyWords\n",
        "Value": "select"
      }
    ],
    "Total": 1,
    "Queries": [
      {
        "Vip": "10.146.XX.XX",
        "NodeId": "pi-bp1o58x3ib7e6****\n",
        "SqlText": "SELECT @@session.transaction_read_only",
        "SqlType": "SELECT",
        "State": "0",
        "DBName": "testdb01",
        "SqlId": "a4111670e80596c5bf42cf5154438a91",
        "ExecuteTime": "2023-12-07T02:15:32Z",
        "OriginTime": 1701886532000,
        "AccountName": "testname\n",
        "HostAddress": "11.197.XX.XX\n",
        "Consume": 58,
        "LockTime": 0,
        "UpdateRows": 0,
        "ScanRows": 0,
        "ReturnRows": 0,
        "LogicRead": 0,
        "PhysicSyncRead": 0,
        "PhysicAsyncRead": 0,
        "ThreadId": 0,
        "TrxId": "200000\n",
        "Ext": "None",
        "Scnt": 10,
        "Rows": 10,
        "Frows": 10,
        "TraceId": "14c93b7c7bf00000 ",
        "UseImciEngine": "true\n",
        "ParallelDegree": "10\n",
        "ParallelQueueTime": "2",
        "PhysicRead": 0,
        "CpuTime": 100,
        "Writes": 10,
        "Collection": "None",
        "SqlCommand": 0,
        "ConnectionId": "ld-******",
        "Protected": "MySQL",
        "Params": "[1, \"das\"]",
        "ClientIp": "10.0.0.1xx",
        "ClientPort": 3306,
        "RowKey": "23",
        "AffectColumns": "[\"col1\"]",
        "TableName": "das"
      }
    ],
    "Export": "\"https://das-sqllog-download-cn-hongkong.oss-cn-hongkong.aliyuncs.com/****\""
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The request parameters are invalid.	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.	You do not have the permission to perform this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.