All Products
Search
Document Center

ApsaraDB RDS:DescribeSlowLogRecords

Last Updated:May 19, 2023

Queries the details of the slow query logs of an instance.

Operation Description

NoteThe response parameters of this operation are updated every minute.

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

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The ID of the instance.

rm-uf6wjk5******
SQLHASHstringNo

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

U2FsdGVk****
StartTimestringYes

The beginning of the time range to query. You can specify a start time up to 30 days earlier than the current time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

2020-06-17T16:00Z
EndTimestringYes

The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

2020-06-18T16:00Z
DBNamestringNo

The name of the database.

RDS_MySQL
PageSizeintegerNo

The number of entries per page. Valid values: 30 to 100.

NoteThe default value is 30.
30
PageNumberintegerNo

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

NoteThe default value is 1.
1

Response parameters

ParameterTypeDescriptionExample
object
PageRecordCountinteger

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

1
RequestIdstring

The ID of the request.

4DBB1BB0-E5D8-4D41-B1C9-142364DB****
TotalRecordCountinteger

The total number of entries returned.

1
DBInstanceIdstring

The ID of the instance.

rm-uf6wjk5*******
Enginestring

The database engine that the instance runs.

MySQL
PageNumberinteger

The page number.

1
Itemsarray

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

object
HostAddressstring

The name and IP address of the client that is connected to the database.

xxx[xxx] @ [1xx.xxx.xxx.xx]
RowsAffectedCountlong

The number of rows that are affected by the SQL statement.

NoteThis parameter is returned only for instances that run SQL Server.
34
QueryTimeslong

The execution duration of the slow query. Unit: seconds.

2
SQLTextstring

The details of the SQL statement.

select sleep(2)
CpuTimelong

The duration during which the SQL statement is processed by the CPU. Unit: milliseconds.

NoteThis parameter is returned only for instances that run SQL Server.
0.002
QueryTimeMSlong

The execution duration of the slow query. Unit: milliseconds.

2001
ApplicationNamestring

The name of the application that is connected to the instance.

NoteThis parameter is returned only for instances that run SQL Server.
example
LockTimeslong

The lock duration of the SQL statement. Unit: seconds.

0
ExecutionStartTimestring

The time when the execution of the SQL statement started. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2020-06-18T01:40:44Z
LogicalIOReadlong

The number of logical reads.

NoteThis parameter is returned only for instances that run SQL Server.
383
WriteIOCountlong

The number of I/O writes.

NoteThis parameter is returned only for instances that run SQL Server.
22
PhysicalIOReadlong

The number of physical reads.

NoteThis parameter is returned only for instances that run SQL Server.
200
ReturnRowCountslong

The number of rows returned by the SQL statement.

1
ParseRowCountslong

The number of rows parsed by the SQL statement.

1
DBNamestring

The name of the database.

testDB
ClientHostNamestring

The hostname of the client.

NoteThis parameter is returned only for instances that run SQL Server.
example
UserNamestring

The username.

NoteThis parameter is returned only for instances that run SQL Server.
user
LastRowsAffectedCountlong

The number of rows that are affected by the last SQL statement.

NoteThis parameter is returned only for instances that run SQL Server.
2
SQLHashstring

The unique ID of the SQL statement.

U2FsdGVk****

Examples

Sample success responses

JSONformat

{
  "PageRecordCount": 1,
  "RequestId": "4DBB1BB0-E5D8-4D41-B1C9-142364DB****",
  "TotalRecordCount": 1,
  "DBInstanceId": "rm-uf6wjk5*******",
  "Engine": "MySQL",
  "PageNumber": 1,
  "Items": {
    "SQLSlowRecord": [
      {
        "HostAddress": "xxx[xxx] @  [1xx.xxx.xxx.xx]",
        "RowsAffectedCount": 34,
        "QueryTimes": 2,
        "SQLText": "select sleep(2)",
        "CpuTime": 0.002,
        "QueryTimeMS": 2001,
        "ApplicationName": "example",
        "LockTimes": 0,
        "ExecutionStartTime": "2020-06-18T01:40:44Z",
        "LogicalIORead": 383,
        "WriteIOCount": 22,
        "PhysicalIORead": 200,
        "ReturnRowCounts": 1,
        "ParseRowCounts": 1,
        "DBName": "testDB",
        "ClientHostName": "example",
        "UserName": "user",
        "LastRowsAffectedCount": 2,
        "SQLHash": "U2FsdGVk****"
      }
    ]
  }
}

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.

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