All Products
Search
Document Center

ApsaraDB RDS:DescribeSlowLogs

Last Updated:May 22, 2024

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:DescribeSlowLogsRead
  • 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-uf6wjk5xxxxxxx
StartTimestringYes

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
EndTimestringYes

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
DBNamestringNo

The name of the database.

RDS_MySQL
SortKeystringNo

The dimension based on which the system sorts the entries to return. Valid values:

  • TotalExecutionCounts: The system sorts the entries to return based on the number of times that SQL statements are executed.
  • TotalQueryTimes: The system sorts the entries to return based on the total execution duration.
  • TotalLogicalReads: The system sorts the entries to return based on the total number of logical reads.
  • TotalPhysicalReads: The system sorts the entries to return based on the total number of physical reads.
Note This parameter is supported only for instances that run SQL Server 2008 R2.
TotalExecutionCounts
PageSizeintegerNo

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

30
PageNumberintegerNo

The page number. Valid values: any non-zero positive integer.

Default value: 1.

1

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

EndTimestring

The end date of the query.

2011-05-30Z
StartTimestring

The start date of the query.

2011-05-30Z
RequestIdstring

The request ID.

2553A660-E4EB-4AF4-A402-8AFF70A49143
PageRecordCountinteger

The number of SQL statements that are returned on the current page.

10
TotalRecordCountinteger

The total number of entries that are returned.

5
DBInstanceIdstring

The ID of the instance.

rm-uf6wjk5xxxxxxx
PageNumberinteger

The number of the page returned.

1
Enginestring

The database engine of the instance.

MySQL
Itemsobject []

An array that consists of the information about each slow query log.

MaxLastRowsAffectedCountslong

The largest number of rows that were affected by the last SQL statement in the query.

Note This parameter is returned only for instances that run SQL Server.
0
ReturnMaxRowCountlong

The largest number of rows that were returned by a specific SQL statement in the query.

1
SQLTextstring

The SQL statement that was executed in the query.

select id,name from tb_table
SQLServerMaxCpuTimelong

The largest amount of CPU time that was used by a specific SQL statement in the query. Unit: seconds.

Note This parameter is returned only for instances that run SQL Server.
0
CreateTimestring

The date when the data was generated.

2011-05-30Z
AvgLastRowsAffectedCountslong

The average number of rows that were affected by the last SQL statement in the query.

Note This parameter is returned only for instances that run SQL Server.
0
MinLastRowsAffectedCountslong

The smallest number of rows that were affected by the last SQL statement in the query.

Note This parameter is returned only for instances that run SQL Server.
0
ParseTotalRowCountslong

The total number of rows that were parsed by all SQL statements in the query.

1
TotalLockTimeslong

The total lock duration that was caused by all SQL statements in the query. Unit: seconds.

0
MySQLTotalExecutionCountslong

The total number of SQL statements that were executed in the query. This parameter is returned only for instances that run MySQL.

1
SQLServerMinCpuTimelong

The smallest amount of CPU time that was used by a specific SQL statement. Unit: seconds.

Note This parameter is returned only for instances that run SQL Server.
0
SQLHASHstring

The unique ID of the SQL statement. The ID is used to obtain the slow query logs of the SQL statement.

U2FsdGVkxxxx
MinIOWriteCountslong

The smallest number of I/O writes that were performed by a specific SQL statement in the query.

Note This parameter is returned only for instances that run SQL Server.
0
ParseMaxRowCountlong

The largest number of rows that were parsed by a specific SQL statement in the query.

1
MaxLogicalReadCountslong

The largest number of logical reads that were performed by a specific SQL statement in the query.

Note This parameter is returned only for instances that run SQL Server.
0
MySQLTotalExecutionTimeslong

The total execution duration of all SQL statements in the query. Unit: seconds. This parameter is returned only for instances that run MySQL.

1
SQLServerTotalExecutionCountslong

The total number of SQL statements that were executed in the query. This parameter is returned only for instances that run SQL Server.

1
ReturnTotalRowCountslong

The total number of rows that were returned by all SQL statements in the query.

1
MaxLockTimelong

The longest lock duration that was caused by a specific SQL statement in the query. Unit: seconds.

0
MaxLockTimeMSlong

The longest lock duration that was caused by a specific SQL statement in the query. Unit: milliseconds.

1000
DBNamestring

The name of the database.

RDS_MySQL
MinRowsAffectedCountslong

The smallest number of rows that were affected by a specific SQL statement in the query.

Note This parameter is returned only for instances that run SQL Server.
0
TotalLogicalReadCountslong

The total number of logical reads that were performed by all SQL statements in the query.

1
TotalPhysicalReadCountslong

The total number of physical reads that were performed by all SQL statements in the query .

1
ReportTimestring

The date on which the data report was generated.

2011-05-30Z
MaxPhysicalReadCountslong

The largest number of physical reads that were performed by a specific SQL statement in the query.

Note This parameter is returned only for instances that run SQL Server.
0
SQLServerTotalCpuTimelong

The total amount of CPU time that was used by all SQL statements in the query. Unit: seconds.

Note This parameter is returned only for instances that run SQL Server.
0
TotalIOWriteCountslong

The total number of I/O writes that were performed by all SQL statements in the query.

Note This parameter is returned only for instances that run SQL Server.
0
MaxRowsAffectedCountslong

The largest number of rows that were affected by a specific SQL statement in the query.

Note This parameter is returned only for instances that run SQL Server.
0
AvgIOWriteCountslong

The average number of I/O writes per SQL statement in the query.

Note This parameter is returned only for instances that run SQL Server.
0
MinPhysicalReadCountslong

The smallest number of physical reads that were performed by a specific SQL statement in the query.

Note This parameter is returned only for instances that run SQL Server.
0
SlowLogIdlong

The ID of the slow query log summary.

26584213
MaxExecutionTimelong

The longest execution duration of a specific SQL statement in the query. Unit: seconds.

60
MaxExecutionTimeMSlong

The longest execution duration of a specific SQL statement in the query. Unit: milliseconds.

60000
AvgExecutionTimelong

The average execution duration per SQL statement in the query. Unit: seconds.

**


1
SQLServerAvgExecutionTimelong

The average execution duration per SQL statement in the query. Unit: seconds.

Note This parameter is returned only for instances that run SQL Server.
0
MaxIOWriteCountslong

The largest number of I/O writes that were performed by a specific SQL statement in the query.

Note This parameter is returned only for instances that run SQL Server.
0
SQLServerAvgCpuTimelong

The average amount of CPU time per SQL statement in the query. Unit: seconds.

Note This parameter is returned only for instances that run SQL Server.
0
TotalLastRowsAffectedCountslong

The total number of rows that were affected by the last SQL statement in the query.

Note This parameter is returned only for instances that run SQL Server.
0
AvgLogicalReadCountslong

The average number of logical reads per SQL statement in the query.

Note This parameter is returned only for instances that run SQL Server.
0
SQLServerMinExecutionTimelong

The smallest execution duration of a specific SQL statement in the query. Unit: seconds.

Note This parameter is returned only for instances that run SQL Server.
0
SQLIdStrstring

The ID of the SQL statement in the statistical template of slow query logs. This parameter is replaced by the SQLHASH parameter.

521584
SQLServerTotalExecutionTimeslong

The total execution duration of all SQL statements in the query. This parameter is returned only for instances that run SQL Server. Unit: milliseconds.

1000
AvgRowsAffectedCountslong

The average number of rows that were affected per SQL statement in the query.

Note This parameter is returned only for instances that run SQL Server.
0
TotalRowsAffectedCountslong

The total number of rows that were affected by all SQL statements in the query.

0
AvgPhysicalReadCountslong

The average number of physical reads per SQL statement in the query.

Note This parameter is returned only for instances that run SQL Server.
0
MinLogicalReadCountslong

The smallest number of logical reads that were performed by a specific SQL statement in the query.

Note This parameter is returned only for instances that run SQL Server.
0

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidSearchTimeRangesearch 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.
400IO.ExceptionIO exception, retry later.An I/O error occurred.
400SortKey.ValueNotSupportedSortKey.ValueNotSupported-

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

Change history

Change timeSummary of changesOperation
2023-05-24The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.