DescribeSQLLogRecords - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries the logs that are generated by the SQL Explorer (SQL Audit) feature for an instance.

Operation Description

Before you call this operation, make sure that the instance runs one of the following database engines:

MySQL
SQL Server
PostgreSQL

Note

You can call this operation up to 1,000 times per minute per account. The calls initiated by using both your Alibaba Cloud account and RAM users within your Alibaba Cloud account are counted.
This operation cannot be used to query the logs that are generated by SQL Explorer Trial Edition for an ApsaraDB RDS for MySQL instance.
When you call this operation and set the Form parameter to File to generate an audit file, a maximum of 1 million log entries can be recorded in the audit file, and you cannot filter log entries by keyword.

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
rds:DescribeSQLLogRecords	READ	RDS acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	none

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.	ETnLKlblzczshOTUbOCzxxxxxxx
DBInstanceId	string	Yes	The ID of the instance.	rm-uf6wjk5xxxxxxx
SQLId	long	No	The unique ID of the SQL statement.	25623548
QueryKeywords	string	No	The keyword that is used for the query. When you call this operation and set the Form parameter to File to generate an audit file, you cannot filter log entries by keyword. You can specify up to 10 keywords. The keywords are evaluated by using the AND operator. Separate multiple keywords with spaces. If a field name in the specified SQL statement is enclosed in backquotes (`) and you want to use the field name as a keyword, you must enter the backquotes (`) as part of the field name. For example, if the field name is `id`, enter `id` rather than id. NoteAfter you enter a keyword, the system matches the keyword based on the Database, User, and QueryKeywords parameters. The parameters are evaluated by using the OR operator.	table_name
StartTime	string	Yes	The beginning of the time range to query. You can query data in the last 15 days before the current date. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2011-06-01T15:00:00Z
Database	string	No	The name of the database. You can enter only one database name. If you specify this parameter, this operation returns the logs that are generated only for the specified database. If you do not specify this parameter, this operation returns the logs that are generated for all databases on the instance.	Database
User	string	No	The username of the account. You can enter only one username. If you specify this parameter, this operation returns the logs that are generated only for the specified account. If you do not specify this parameter, this operation returns the logs that are generated for all accounts on the instance.	user
Form	string	No	Specifies whether to generate an SQL audit log file or return SQL audit log entries. Valid values: File: If you set this parameter to File, this operation generates an SQL audit log file and returns only common response parameters. After you call this operation, you must call the DescribeSQLLogFiles operation to obtain the download URL of the SQL audit log file. Stream (default): If you set this parameter to Stream, this operation returns SQL audit log entries. NoteIf you set this parameter to File, only ApsaraDB RDS for MySQL instances that use local disks and ApsaraDB RDS for SQL Server instances are supported, and a maximum of 1 million log entries are returned.	Stream
EndTime	string	Yes	The end of the time range to query. The end time must be later than the start time. The time span between the start time and the end time must be less than 30 days. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2011-06-11T15:00:00Z
PageSize	integer	No	The number of entries to return on each page. Valid values: 30 to 100. Default value: 30.	30
PageNumber	integer	No	The number of the page to return. Valid values: any non-zero positive integer. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	08A3B71B-FE08-4B03-974F-CC7EA6DB1828
PageNumber	integer	The page number of the returned page.	1
PageRecordCount	integer	The number of SQL audit log entries on the current page.	30
TotalRecordCount	long	The total number of entries returned.	100
Items	object []	An array that consists of the details about each SQL audit log entry.
HostAddress	string	The IP address of the client that is connected to the instance.	192.168.0.121
SQLText	string	The SQL statement that is executed in the query.	update test.zxb set id=0 limit 1
ReturnRowCounts	long	The number of SQL audit log entries that are returned.	30
DBName	string	The name of the database.	testDB
ExecuteTime	string	The time at which the SQL statement was executed. The time follows the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2011-06-11T15:00:23Z
ThreadID	string	The ID of the thread.	1025865428
TotalExecutionTimes	long	The execution duration of the SQL statement. Unit: microseconds.	600
AccountName	string	The username of the account that is recorded in the SQL audit log entry.	accounttest

Examples

Sample success responses

JSONformat

{
  "RequestId": "08A3B71B-FE08-4B03-974F-CC7EA6DB1828",
  "PageNumber": 1,
  "PageRecordCount": 30,
  "TotalRecordCount": 100,
  "Items": {
    "SQLRecord": [
      {
        "HostAddress": "192.168.0.121",
        "SQLText": "update test.zxb set id=0 limit 1",
        "ReturnRowCounts": 30,
        "DBName": "testDB",
        "ExecuteTime": "2011-06-11T15:00:23Z",
        "ThreadID": "1025865428",
        "TotalExecutionTimes": 600,
        "AccountName": "accounttest"
      }
    ]
  }
}

Error codes

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