DescribeSqlLogTasks - Database Autonomy Service

Queries the SQL Explorer and Audit tasks of a database instance for which Database Autonomy Service (DAS) Enterprise Edition is enabled.

Operation description

Before you call this operation, take note of the following items:

If you use an Alibaba Cloud SDK or a DAS SDK to call this operation, we recommend that you use the latest version of the SDK.
If you use an SDK to call operations of DAS, you must set the region ID to cn-shanghai.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
hdm:DescribeSqlLogTasks	list	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The ID of the database instance.	r-bp1nti25tc7bq5****
NodeId	string	No	The node ID. Note This parameter is available only for instances that are deployed in the cluster architecture. You can specify this parameter to query the tasks of a specific node. If this parameter is not specified, the tasks of the primary node are returned by default.	pi-bp1o58x3ib7e6z496
Filters	array<object>	No	The filter parameters.
	object	No
Key	string	No	The name of the filter parameter. Note For more information about the filter parameters, see the Valid values of Key section of this topic.	delimiter
Value	string	No	The value of the filter parameter.	,
StartTime	long	No	The beginning of the time range to query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1596177993000
EndTime	long	No	The end of the time range to query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1608888296000
PageNo	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10

Supported parameters and values for Key

KeyWords: the keywords. Separate multiple keywords with spaces.
LogicalOperator: the logical operator between keywords. Valid values: and and or.
AccountName: the database account. You can specify up to five accounts. Separate multiple accounts with commas (,).
dbName: the database name. You can specify up to five database names. Separate multiple database names with commas (,).
HostAddress: the IP address of the client. You can specify up to five IP addresses. Separate multiple IP addresses with commas (,).
MaxConsume: the maximum execution duration. Unit: microseconds.
MinConsume: the minimum execution duration. Unit: microseconds.
MaxScanRows: the maximum number of rows that are scanned.
MinScanRows: the minimum number of rows that are scanned.
SqlType: the type of the SQL statement. Valid values: select, update, insert, and delete.
State: the execution result. Valid values: 0 and 1. A value of 0 indicates that the execution was successful. A value of 1 indicates that the execution failed.
ThreadId: the thread ID.
SortKey: the name of the column that is used for sorting. Valid values: ScanRows, UpdateRows, Consume, ExecuteTime, ReturnRows, LockTime, Frows, Scnt, CpuTime, and PhysicalRead. A value of ScanRows indicates the number of rows that are scanned. A value of UpdateRows indicates the number of rows that are updated. A value of Consume indicates the amount of time that is consumed. A value of ExecuteTime indicates the time when the SQL statement was executed. A value of ReturnRows indicates the number of rows that are returned. A value of LockTime indicates the lock wait duration. A value of Frows indicates the number of rows that are pulled by the compute nodes of the PolarDB-X 2.0 instance. A value of Scnt indicates the number of requests that are sent from the compute nodes to the data nodes of the PolarDB-X 2.0 instance. A value of CpuTime indicates the CPU execution duration. A value of PhysicalRead indicates the number of physical reads.
SortMethod: the order in which the queried logs are sorted. Valid values: DESC and ASC. A value of DESC indicates the descending order. A value of ASC indicates the ascending order. Default value: DESC.
TraceId: the trace ID of the PolarDB-X 2.0 instance.
MinRows: the minimum number of rows that are updated.
MaxRows: the maximum number of rows that are updated.
MinScnt: the minimum number of requests that are sent from the compute nodes to the data nodes of the PolarDB-X 2.0 instance.
MaxScnt: the maximum number of requests that are sent from the compute nodes to the data nodes of the PolarDB-X 2.0 instance.
TrxId: the transaction ID.
Fail: the error code.
sqlId: the SQL statement ID.

Response parameters

Parameter	Type	Description	Example
	object
Code	string	The response code.	200
Message	string	The returned message. Note If the request was successful, Successful is returned. If the request failed, an error message is returned.	Successful
RequestId	string	The request ID.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	Indicates whether the request was successful. Valid values: true false	true
Data	object	The data returned.
List	array<object>	The details of the data returned.
	object
TaskId	string	The task ID.	9a4f5c4494dbd6713185d87a97aa53e8
InstanceId	string	The ID of the database instance.	rm-2zew761kf7ho18752
Name	string	The task name.	test01
Start	long	The time when the task started. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1683859555482
End	long	The time when the task ended. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1705975320000
Status	string	The task state. Valid values: INIT: The task is to be scheduled. RUNNING: The task is running. FAILED: The task failed. CANCELED: The task is canceled. COMPLETED: The task is complete. Note If a task is in the COMPLETED state, you can view the results of the task.	RUNNING
LogCount	long	The number of log records.	99999
Progress	integer	The task progress.	100
ScanFileSize	long	The number of files that are scanned.	3000
Expire	boolean	Indicates whether the task expired. Valid values: true false	false
CreateTime	long	The time when the task was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1681363254423
AnalysisTaskFinishTime	long	The time when the analysis task was complete. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1712751923000
AnalysisTaskStatus	string	The state of the analysis task. Note This parameter is a system parameter. You do not need to pay attention to the parameter.	SCAN_ANALYZE_COMPLETED
Result	string	The URL that is returned if the value of TaskType is Export.	https://das-sqllog-download-cn-shanghai.oss-cn-shanghai.aliyuncs.com/la
TaskType	string	The task type. Valid values: Export Query	Export
Filters	array<object>	The filter parameters.
	object
Key	string	The name of the filter parameter. Note For more information about the filter parameters, see the Valid values of Key section of this topic.	delimiter
Value	string	The value of the filter parameter.	,
Total	long	The number of tasks.	40
PageNo	long	The page number.	1
PageSize	long	The number of entries per page.	10

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true",
  "Data": {
    "List": [
      {
        "TaskId": "9a4f5c4494dbd6713185d87a97aa53e8",
        "InstanceId": "rm-2zew761kf7ho18752",
        "Name": "test01",
        "Start": 1683859555482,
        "End": 1705975320000,
        "Status": "RUNNING",
        "LogCount": 99999,
        "Progress": 100,
        "ScanFileSize": 3000,
        "Expire": false,
        "CreateTime": 1681363254423,
        "AnalysisTaskFinishTime": 1712751923000,
        "AnalysisTaskStatus": "SCAN_ANALYZE_COMPLETED",
        "Result": "https://das-sqllog-download-cn-shanghai.oss-cn-shanghai.aliyuncs.com/la",
        "TaskType": "Export",
        "Filters": [
          {
            "Key": "delimiter",
            "Value": ","
          }
        ]
      }
    ],
    "Total": 40,
    "PageNo": 1,
    "PageSize": 10
  }
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

For a list of error codes, visit the Service error codes.