Queries the log files that are generated by the SQL Explorer (SQL Audit) feature for an instance. The DescribeSQLLogFiles operation does not return the log files that are generated by the SQL Explorer feature and manually exported from the ApsaraDB RDS console. The DescribeSQLLogFiles operation returns the SQL Explorer log files that are generated by calling the DescribeSQLLogRecords operation with the request parameter Form set to File.
Operation description
Supported database engines
-
MySQL
-
PostgreSQL
-
SQL Server
**
Note Only SQL Server 2008 R2 is supported.
Precautions
- The DescribeSQLLogFiles operation does not return the log files that are generated by SQL Explorer Trial Edition for an ApsaraDB RDS for MySQL instance.
- The DescribeSQLLogFiles operation does not return the log files that are generated by the SQL Explorer feature and manually exported from the ApsaraDB RDS console. The DescribeSQLLogFiles operation returns the SQL Explorer log files that are generated by calling the DescribeSQLLogRecords operation with the request parameter Form set to File.
Debugging
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:DescribeSQLLogFiles | READ |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBInstanceId | string | Yes | The instance ID. You can call the DescribeDBInstances operation to query the instance ID. | rm-uf6wjk5xxxxxx |
FileName | string | No | The name of the audit log file. | custinsxxxxx.csv |
PageSize | integer | No | The number of entries to return on each page. Valid value: 30 to 200. Default value: 30. | 30 |
PageNumber | integer | No | The number of the page to return. Valid values: 1 to 100000. Default value: 1. | 1 |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": " 1AD222E9-E606-4A42-BF6D-8A4442913CEF",
"PageNumber": 1,
"PageRecordCount": 10,
"TotalRecordCount": 10,
"Items": {
"LogFile": [
{
"FileID": "custinsxxxxx.csv",
"LogStartTime": "2015-05-23T07:00:00Z",
"LogSize": "3000",
"LogDownloadURL": "http://rdslog-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx",
"LogEndTime": "2015-05-24T07:00:00Z",
"LogStatus": "Success"
}
]
}
}
Error codes
For a list of error codes, visit the Service error codes.