Queries the statistics on slow query logs.
Operation description
Supported database engines
-
MySQL
**
Note This operation is not supported for RDS instances that run MySQL 5.7 on RDS Basic Edition.
-
SQL Server
**
Note This operation is supported only for RDS instances that run SQL Server 2008 R2.
-
MariaDB
Precautions
- Slow query logs are not collected in real time and may show a latency of 6 to 8 hours.
- If the return result is empty, check whether the StartTime and EndTime parameters meet the UTC format. If the parameters meet the UTC format, no slow logs are generated within the specified time range.
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:DescribeSlowLogs | 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-uf6wjk5xxxxxxx |
StartTime | string | Yes | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddZ format. The time must be in UTC. | 2011-05-01Z |
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 cannot exceed 31 days. Specify the time in the ISO 8601 standard in the yyyy-MM-ddZ format. The time must be in UTC. | 2011-05-30Z |
DBName | string | No | The name of the database. | RDS_MySQL |
SortKey | string | No | The dimension based on which the system sorts the entries to return. Valid values:
Note
This parameter is supported only for instances that run SQL Server 2008 R2.
| TotalExecutionCounts |
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 page number. Valid values: any non-zero positive integer. Default value: 1. | 1 |
Response parameters
Examples
Sample success responses
JSON
format
{
"EndTime": "2011-05-30Z",
"StartTime": "2011-05-30Z",
"RequestId": "2553A660-E4EB-4AF4-A402-8AFF70A49143",
"PageRecordCount": 10,
"TotalRecordCount": 5,
"DBInstanceId": "rm-uf6wjk5xxxxxxx",
"PageNumber": 1,
"Engine": "MySQL",
"Items": {
"SQLSlowLog": [
{
"MaxLastRowsAffectedCounts": 0,
"ReturnMaxRowCount": 1,
"SQLText": "select id,name from tb_table",
"SQLServerMaxCpuTime": 0,
"CreateTime": "2011-05-30Z",
"AvgLastRowsAffectedCounts": 0,
"MinLastRowsAffectedCounts": 0,
"ParseTotalRowCounts": 1,
"TotalLockTimes": 0,
"MySQLTotalExecutionCounts": 1,
"SQLServerMinCpuTime": 0,
"SQLHASH": "U2FsdGVkxxxx",
"MinIOWriteCounts": 0,
"ParseMaxRowCount": 1,
"MaxLogicalReadCounts": 0,
"MySQLTotalExecutionTimes": 1,
"SQLServerTotalExecutionCounts": 1,
"ReturnTotalRowCounts": 1,
"MaxLockTime": 0,
"MaxLockTimeMS": 1000,
"DBName": "RDS_MySQL",
"MinRowsAffectedCounts": 0,
"TotalLogicalReadCounts": 1,
"TotalPhysicalReadCounts": 1,
"ReportTime": "2011-05-30Z",
"MaxPhysicalReadCounts": 0,
"SQLServerTotalCpuTime": 0,
"TotalIOWriteCounts": 0,
"MaxRowsAffectedCounts": 0,
"AvgIOWriteCounts": 0,
"MinPhysicalReadCounts": 0,
"SlowLogId": 26584213,
"MaxExecutionTime": 60,
"MaxExecutionTimeMS": 60000,
"AvgExecutionTime": 1,
"SQLServerAvgExecutionTime": 0,
"MaxIOWriteCounts": 0,
"SQLServerAvgCpuTime": 0,
"TotalLastRowsAffectedCounts": 0,
"AvgLogicalReadCounts": 0,
"SQLServerMinExecutionTime": 0,
"SQLIdStr": "521584",
"SQLServerTotalExecutionTimes": 1000,
"AvgRowsAffectedCounts": 0,
"TotalRowsAffectedCounts": 0,
"AvgPhysicalReadCounts": 0,
"MinLogicalReadCounts": 0
}
]
}
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidSearchTimeRange | search time range cannot be longer than a month. | The interval between the end time that is specified by the EndTime parameter and the start time that is specified by the StartTime parameter must be less than 31 days. Check the values of these parameters. |
400 | IO.Exception | IO exception, retry later. | An I/O error occurred. |
400 | SortKey.ValueNotSupported | SortKey.ValueNotSupported | - |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||
---|---|---|---|---|---|---|---|---|
2023-05-24 | The Error code has changed. The response structure of the API has changed | see changesets | ||||||
|