DescribeSQLLogReportList - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries SQL log reports.

Operation description

Supported database engines

MySQL
PostgreSQL
SQL Server
MariaDB

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
rds:DescribeSQLLogReportList	get	*DBInstance `acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}`	rds:ResourceTag	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-uf6wjk5xxxxxxx
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2021-03-13T16:00:00Z
EndTime	string	Yes	The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note** The end time must be later than the start time.	2021-03-18T16:00:00Z
PageSize	integer	No	The number of entries per page. Valid values: 30 50 100 Default value: 30.	30
PageNumber	integer	No	The page number. Valid values: any non-zero positive integer. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	08A3B71B-FE08-4B03-974F-CC7EA6DB1828
PageNumber	integer	The page number.	1
PageRecordCount	integer	The number of SQL log reports on the current page.	30
TotalRecordCount	integer	The total number of entries.	60
Items	array<object>	An array that consists of SQL log reports.
Item	object
ReportTime	string	The time when the report was generated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-03-27T16:00:00Z
LatencyTopNItems	array<object>	An array that consists of SQL statements executed with the highest latency.
LatencyTopNItem	object
SQLText	string	The SQL statement. Note Only the first 128 characters of the SQL statement are returned. In addition, only the SQL statements that take more than 100 ms to execute are returned.	SELECT * FROM table_name;
SQLExecuteTimes	long	The number of times that the SQL statement is executed.	5
AvgLatency	long	The average time that is required to execute the SQL statement. Unit: milliseconds.	500
QPSTopNItems	array<object>	An array that consists of SQL statements executed the most frequently.
QPSTopNItem	object
SQLExecuteTimes	long	The number of times that the SQL statement is executed.	5
SQLText	string	The SQL statement. Note Only the first 128 characters of the SQL statement are returned. In addition, only the SQL statements that take more than 5 ms to execute are returned.	SELECT * FROM table_name;

Examples

Sample success responses

JSONformat

{
  "RequestId": "08A3B71B-FE08-4B03-974F-CC7EA6DB1828\t",
  "PageNumber": 1,
  "PageRecordCount": 30,
  "TotalRecordCount": 60,
  "Items": {
    "Item": [
      {
        "ReportTime": "2019-03-27T16:00:00Z",
        "LatencyTopNItems": {
          "LatencyTopNItem": [
            {
              "SQLText": "SELECT * FROM table_name;",
              "SQLExecuteTimes": 5,
              "AvgLatency": 500
            }
          ]
        },
        "QPSTopNItems": {
          "QPSTopNItem": [
            {
              "SQLExecuteTimes": 5,
              "SQLText": "SELECT * FROM table_name;"
            }
          ]
        }
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-11-18	API Description Update. The Error code has changed	View Change Details