All Products
Search
Document Center

ApsaraDB RDS:DescribeSlowLogRecords

Last Updated:May 11, 2024

Queries the slow log details of an instance.

Operation description

Supported database engines

  • MySQL
  • PostgreSQL
  • SQL Server
  • MariaDB

Precautions

The response parameters returned by this operation are updated every minute.

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

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The ID of the instance. You can call the DescribeDBInstances operation to query 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. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

2020-06-17T16:00Z
EndTimestringYes

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.
2020-06-18T16:00Z
DBNamestringNo

The name of the database.

RDS_MySQL
PageSizeintegerNo

The number of entries per page. Valid value: 30 to 200. Default value: 30.

30
PageNumberintegerNo

The page number. Pages start from page 1. Default value: 1.

1
NodeIdstringNo

The ID of the node.

Note This parameter is available only for instances that run RDS Cluster Edition. You can specify this parameter to query the logs of a specified node. If this parameter is not specified, the logs of the primary node are returned by default.
rn-p1fm78s90x5****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

PageRecordCountinteger

The number of SQL log reports 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 type of the database engine.

MySQL
PageNumberinteger

The page number.

1
Itemsobject []

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

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 affected rows.

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

The execution duration of the 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.

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

The execution duration of the query. Unit: milliseconds.

2001
ApplicationNamestring

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

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

The lock duration of the query. 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.

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

The number of I/O writes.

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

The number of physical reads.

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

The number of rows returned.

1
ParseRowCountslong

The number of parsed rows.

1
DBNamestring

The name of the database.

testDB
ClientHostNamestring

The hostname of the client.

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

The name of the user.

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

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

Note This 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.

Change history

Change timeSummary of changesOperation
2023-06-06The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
2023-06-02The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: NodeId