All Products
Search
Document Center

ApsaraDB RDS:DescribeSQLLogFiles

Last Updated:Jan 16, 2024

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
rds:DescribeSQLLogFilesREAD
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The instance ID. You can call the DescribeDBInstances operation to query the instance ID.

rm-uf6wjk5xxxxxx
FileNamestringNo

The name of the audit log file.

custinsxxxxx.csv
PageSizeintegerNo

The number of entries to return on each page. Valid value: 30 to 200. Default value: 30.

30
PageNumberintegerNo

The number of the page to return. Valid values: 1 to 100000. Default value: 1.

1

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

1AD222E9-E606-4A42-BF6D-8A4442913CEF
PageNumberinteger

The page number of the returned page.

1
PageRecordCountinteger

The number of entries returned per page.

10
TotalRecordCountinteger

The total number of entries returned.

10
Itemsobject []

An array that consists of the returned audit log files.

FileIDstring

The file name.

custinsxxxxx.csv
LogStartTimestring

The time at which the first SQL statement recorded in the audit log file was executed. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2015-05-23T07:00:00Z
LogSizestring

The size of the audit log file. Unit: bytes.

3000
LogDownloadURLstring

The download URL of the file. If the audit log file cannot be downloaded, this parameter is null.

http://rdslog-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx
LogEndTimestring

The time at which the last SQL statement recorded in the audit log file was executed. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2015-05-24T07:00:00Z
LogStatusstring

The status of the audit log file. Valid values:

  • Success
  • Failed
  • Generating
Success

Examples

Sample success responses

JSONformat

{
  "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.