DescribeSQLLogFiles - ApsaraDB RDS - Alibaba Cloud Documentation Center

You can call the DescribeSQLLogFiles operation to query the audit log files that are generated by the SQL Explorer and Audit feature for an ApsaraDB RDS instance.

Operation Description

An array that consists of the returned audit log files.

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

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The download URL of the audit log file. If the audit log file cannot be downloaded, this parameter is null.	rm-uf6wjk5xxxxxx
FileName	string	No	The number of entries to return on each page. Valid value: 30 to 200. Default value: 30.	custinsxxxxx.csv
PageSize	integer	No	The operation that you want to perform. Set the value to DescribeSQLLogFiles.	30
PageNumber	integer	No	The name of the audit log file.	1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The total number of returned entries.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
PageNumber	integer	The ID of the instance.	1
PageRecordCount	integer	The number of entries returned on the current page.	10
TotalRecordCount	integer	The number of the page to return. Valid values: 1 to 100000. Default value: 1.	10
Items	object []	The page number of the returned page.
FileID	string	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.	custinsxxxxx.csv
LogStartTime	string	The ID of the request.	2015-05-23T07:00:00Z
LogSize	string	You can call the DescribeSQLLogFiles operation to query the audit log files that are generated by the SQL Explorer and Audit feature for an ApsaraDB RDS instance.	3000

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.