DescribeSqlLogRecords - - Alibaba Cloud Documentation Center

Queries the log details 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 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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:DescribeSqlLogRecords	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The database instance ID.	pc-2ze8g2am97624****
NodeId	string	No	The node ID. For ApsaraDB RDS for MySQL instances and PolarDB for MySQL clusters, this parameter is valid only for instances of the Cluster Edition. If you do not specify this parameter, the log details of the primary node is queried by default. For PolarDB-X 2.0 instances, set this parameter to polarx_cn if the node is a compute node, or polarx_dn if the node is a data node.	pi-uf6k5f6g3912i****
Role	string	No	The role of the node of the PolarDB-X 2.0 instance. Valid values: polarx_cn: compute node polarx_dn: data node	polarx_cn
Filters	array<object>	No	The filter conditions.
Item	object	No
Key	string	No	The filter parameter. Note For more information about the supported filter parameters and their valid values, see the Supported parameters and values for Key section of this topic.	keyWords
Value	string	No	The value of the filter parameter.	select
StartTime	long	No	The beginning of the time range to query. This value is a UNIX timestamp. Unit: millisecond.	1596177993000
EndTime	long	No	The end of the time range to query. This value is a UNIX timestamp. Unit: millisecond.	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. Default value: 10.	10

Supported parameters and values for Key

KeyWords: the keywords. Separate multiple keywords with spaces.
LogicalOperator: the logical operation between keywords. Valid values: and and or.
AccountName: the username.
DBName: the database name.
HostAddress: the IP address of the client.
MaxConsume: the maximum amount of time that is consumed. Unit: millisecond.
MinConsume: the minimum amount of time that is consumed. Unit: millisecond.
MaxScanRows: the maximum number of rows that are scanned.
MinScanRows: the minimum number of rows that are scanned.
SqlType: the type 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 SQL statement execution is successful. A value of 1 indicates that the SQL statement fails to be executed.
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.
JobId: the asynchronous task ID. For a database instance for which DAS Enterprise Edition V0 or DAS Enterprise Edition V1 is enabled, you can specify this parameter to query task results.

Response parameters

Parameter	Type	Description	Example
	object
Code	string	The HTTP status code that is returned.	200
Message	string	The message that is returned. Note If the request is successful, Successful is returned. If the request fails, an error message that contains information such as an error code is returned.	Successful
RequestId	string	The request ID.	F43E7FB3-CE67-5FFD-A59C-EFD278BCD7BE
Success	string	Indicates whether the request was successful. Valid values: true false	true
Data	object	The data that is returned.
StartTime	long	The beginning of the time range to query. This value is a UNIX timestamp. Unit: millisecond.	1596177993000
EndTime	long	The end of the time range to query. This value is a UNIX timestamp. Unit: millisecond.	1608888296000
TotalRecords	long	The total number of entries.	1
Items	object	The data.
SQLLogRecord	array<object>	The SQL log data.
Item	object
Ext	string	The extended information. This parameter is a reserved parameter.	None
ExecuteTime	string	The time when the SQL statement was executed. The time follows the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.	2023-12-07T02:15:32Z
OriginTime	long	The timestamp generated when the SQL statement was executed. The value of this parameter is a UNIX timestamp. Unit: millisecond.	1701886532000
HostAddress	string	The IP address of the client.	11.197.XX.XX
UpdateRows	long	The number of rows that are updated.	0
LogicRead	long	The number of logical reads.	0
SqlText	string	The SQL statement.	select resource_id as cluster_id, tpl_name \n\tfrom dbfree_alert_resource_tpl_ref\n\twhere user_id=? and type='cluster' group by resource_id, tpl_name
LockTime	long	The lock wait duration. Unit: millisecond.	0
ScanRows	long	The number of scanned rows.	0
ThreadId	long	The thread ID.	None
State	string	The execution status of the SQL statement. 0: The execution was successful. 1: The execution failed.	0
DBName	string	The database name.	testdb
SqlType	string	The type of the SQL statement.	select
AccountName	string	The account of the database.	testname
PhysicSyncRead	long	The number of physical synchronous reads.	0
PhysicAsyncRead	long	The number of physical asynchronous reads.	0
TrxId	integer	The transaction ID.	200000
ReturnRows	long	The number of rows returned by the SQL statement.	0
Consume	long	The amount of time that is consumed to execute the SQL statement. Unit: millisecond.	58
Vip	string	The IP address that is resolved from the endpoint of the query link.	100.115.XX.XX
NodeId	string	The node ID.	pi-uf6k5f6g3912i****
SqlId	string	The SQL statement ID.	c67649d4a7fb62c4f8c7a447c52b5b17
UseImciEngine	string	Indicates whether the In-Memory Column Index (IMCI) feature is enabled for the PolarDB for MySQL cluster. Valid values: true false	true
ParallelQueueTime	string	The parallelism of the PolarDB for MySQL cluster.	2
ParallelDegree	string	The parallel queue time of the PolarDB for MySQL instance. Unit: millisecond.	10
Scnt	long	The number of requests that are sent from the compute nodes to the data nodes of the PolarDB-X 2.0 instance.	10
Rows	long	The total number of rows that are updated or returned by the compute nodes of the PolarDB-X 2.0 instance.	10
Frows	long	The number of rows that are pulled by the compute nodes of the PolarDB-X 2.0 instance.	10
TraceId	string	The trace ID of the PolarDB-X 2.0 instance. The value is the execution ID of the SQL statement on the data node.	14c93b7c7bf00000
PhysicRead	long	The total number of physical reads.	0
CpuTime	long	The CPU execution duration. Unit: microsecond.	100
Writes	long	The number of writes to the ApsaraDB RDS for SQL Server instance.	10
Collection	string	A reserved parameter.	None
Finish	string	Indicates whether the task was complete. Valid values: 0: no 1: yes Note If the value of Finish is 0 and the value of JobId is returned, the request is an asynchronous request and the return result cannot be directly obtained. You must query the return result based on the value of JobId. Specify JobId as the key of Filters and the value of JobId as the value of Filters. Example: `Filters=[{"Key": "JobId", "Value": "******"}]`.	1
JobId	string	The ID of the asynchronous task.	MzI4NTZfUUlOR0RBT19DTTlfTlUyMF9NWVNRTF9PREJTX0xWU18zMjg1Nl9teXNxbF9XZWQgTWFyIDA2IDE0OjUwOjQ3IENTVCAyMDI0XzBfMzBfRXhlY3V0ZVRpbWVfREVTQ19XZWQgTWFyIDA2IDE0OjM1OjQ3IENTVCAyMDI0Xw==_1709708406465

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "F43E7FB3-CE67-5FFD-A59C-EFD278BCD7BE",
  "Success": "true",
  "Data": {
    "StartTime": 1596177993000,
    "EndTime": 1608888296000,
    "TotalRecords": 1,
    "Items": {
      "SQLLogRecord": [
        {
          "Ext": "None",
          "ExecuteTime": "2023-12-07T02:15:32Z",
          "OriginTime": 1701886532000,
          "HostAddress": "11.197.XX.XX",
          "UpdateRows": 0,
          "LogicRead": 0,
          "SqlText": "select resource_id as cluster_id, tpl_name \\n\\tfrom dbfree_alert_resource_tpl_ref\\n\\twhere user_id=? and type='cluster' group by resource_id, tpl_name",
          "LockTime": 0,
          "ScanRows": 0,
          "ThreadId": 0,
          "State": "0",
          "DBName": "testdb",
          "SqlType": "select",
          "AccountName": "testname",
          "PhysicSyncRead": 0,
          "PhysicAsyncRead": 0,
          "TrxId": 200000,
          "ReturnRows": 0,
          "Consume": 58,
          "Vip": "100.115.XX.XX",
          "NodeId": "pi-uf6k5f6g3912i****",
          "SqlId": "c67649d4a7fb62c4f8c7a447c52b5b17",
          "UseImciEngine": "true",
          "ParallelQueueTime": "2",
          "ParallelDegree": "10",
          "Scnt": 10,
          "Rows": 10,
          "Frows": 10,
          "TraceId": "14c93b7c7bf00000 ",
          "PhysicRead": 0,
          "CpuTime": 100,
          "Writes": 10,
          "Collection": "None"
        }
      ]
    },
    "Finish": "1",
    "JobId": "MzI4NTZfUUlOR0RBT19DTTlfTlUyMF9NWVNRTF9PREJTX0xWU18zMjg1Nl9teXNxbF9XZWQgTWFyIDA2IDE0OjUwOjQ3IENTVCAyMDI0XzBfMzBfRXhlY3V0ZVRpbWVfREVTQ19XZWQgTWFyIDA2IDE0OjM1OjQ3IENTVCAyMDI0Xw==_1709708406465"
  }
}

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.

Change history

Change time	Summary of changes	Operation
2024-05-22	The Error code has changed. The response structure of the API has changed	View Change Details