Help Center/ Data Admin Service/ API Reference/ APIs (in OBT)/ Intelligent O&M/ Querying Top Slow SQL Statements of an Instance
Updated on 2025-11-26 GMT+08:00

Querying Top Slow SQL Statements of an Instance

Function

This API is used to query top slow SQL statements of an instance.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions Policies and Supported Actions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: Required)

    Condition Key

    Alias

    Dependency

    das::showCloudDBAInfo

    read

    -

    -

    -

    -

URI

GET /v3/{project_id}/instances/{instance_id}/top-slow-log

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Values:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

N/A

instance_id

Yes

String

Explanation:

Unique ID of an instance

Constraints:

N/A

Values:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

N/A

Table 2 Query parameters

Parameter

Mandatory

Type

Description

num

Yes

Integer

Explanation:

Top N

Constraints:

N/A

Values:

[0, 2^31-1]. The actual value depends on the query result.

Default value:

N/A

start_at

Yes

Long

Explanation:

Start time

Constraints:

Unix timestamp, in milliseconds

Values:

[0, 2^31-1]. The actual value depends on the query result.

Default value:

N/A

end_at

Yes

Long

Explanation:

End time

Constraints:

Unix timestamp, in milliseconds

Values:

[0, 2^31-1]. The actual value depends on the query result.

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

top_execute_slow_logs

Array of Table 4 objects

Explanation:

Execution times

Values:

N/A

top_avg_query_time_slow_logs

Array of Table 5 objects

Explanation:

Average execution duration list

Values:

N/A

top_max_query_time_slow_logs

Array of Table 6 objects

Explanation:

Maximum execution duration list

Values:

N/A

rows_examined_exceeding

Array of Table 7 objects

Explanation:

List of percentage of returned rows to scanned rows

Values:

N/A

Table 4 top_execute_slow_logs

Parameter

Type

Description

template_id

String

Explanation:

SQL template ID

Values:

N/A

template

String

Explanation:

SQL template

Values:

N/A

databases

Array of strings

Explanation:

Database name

Values:

N/A

times

Long

Explanation:

Execution times

Values:

N/A

avg_query_time

Double

Explanation:

Average execution duration

Values:

N/A

max_query_time

Double

Explanation:

Maximum execution duration

Values:

N/A

avg_rows_examined

Double

Explanation:

Average rows scanned

Values:

N/A

sum_rows_examined

Double

Explanation:

Total rows scanned

Values:

N/A

avg_rows_sent

Double

Explanation:

Average rows returned

Values:

N/A

Table 5 top_avg_query_time_slow_logs

Parameter

Type

Description

template_id

String

Explanation:

SQL template ID

Values:

N/A

template

String

Explanation:

SQL template

Values:

N/A

databases

Array of strings

Explanation:

Database name

Values:

N/A

times

Long

Explanation:

Execution times

Values:

N/A

avg_query_time

Double

Explanation:

Average execution duration

Values:

N/A

max_query_time

Double

Explanation:

Maximum execution duration

Values:

N/A

avg_rows_examined

Double

Explanation:

Average rows scanned

Values:

N/A

sum_rows_examined

Double

Explanation:

Total rows scanned

Values:

N/A

avg_rows_sent

Double

Explanation:

Average rows returned

Values:

N/A

Table 6 top_max_query_time_slow_logs

Parameter

Type

Description

template_id

String

Explanation:

SQL template ID

Values:

N/A

template

String

Explanation:

SQL template

Values:

N/A

databases

Array of strings

Explanation:

Database name

Values:

N/A

times

Long

Explanation:

Execution times

Values:

N/A

avg_query_time

Double

Explanation:

Average execution duration

Values:

N/A

max_query_time

Double

Explanation:

Maximum execution duration

Values:

N/A

avg_rows_examined

Double

Explanation:

Average rows scanned

Values:

N/A

sum_rows_examined

Double

Explanation:

Total rows scanned

Values:

N/A

avg_rows_sent

Double

Explanation:

Average rows returned

Values:

N/A

Table 7 rows_examined_exceeding

Parameter

Type

Description

template_id

String

Explanation:

SQL template ID

Values:

N/A

template

String

Explanation:

SQL template

Values:

N/A

databases

Array of strings

Explanation:

Database name

Values:

N/A

times

Long

Explanation:

Execution times

Values:

N/A

avg_query_time

Double

Explanation:

Average execution duration

Values:

N/A

max_query_time

Double

Explanation:

Maximum execution duration

Values:

N/A

avg_rows_examined

Double

Explanation:

Average rows scanned

Values:

N/A

sum_rows_examined

Double

Explanation:

Total rows scanned

Values:

N/A

avg_rows_sent

Double

Explanation:

Average rows returned

Values:

N/A

Example Request

"GEThttps://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/5c59fa7d6f09456b947f32922f9aeda1in01/top-slow-log?num=10&start_at=1736402167045&end_at=1736403967045"

Example Response

Status code: 200

Successful request

{
  "top_execute_slow_logs": [
    {
      "template_id": "1D7880577913B207",
      "template": "SELECT sleep(?);",
      "databases": [],
      "times": 21,
      "avg_query_time": 6.429124786740258,
      "max_query_time": 10,
      "avg_rows_examined": 0,
      "sum_rows_examined": 0,
      "avg_rows_sent": 1
    }
  ],
  "top_avg_query_time_slow_logs": [
    {
      "template_id": "1D7880577913B207",
      "template": "SELECT sleep(?);",
      "databases": [],
      "times": 21,
      "avg_query_time": 6.429124786740258,
      "max_query_time": 10,
      "avg_rows_examined": 0,
      "sum_rows_examined": 0,
      "avg_rows_sent": 1
    }
  ],
  "top_max_query_time_slow_logs": [
    {
      "template_id": "1D7880577913B207",
      "template": "SELECT sleep(?);",
      "databases": [],
      "times": 21,
      "avg_query_time": 6.429124786740258,
      "max_query_time": 10,
      "avg_rows_examined": 0,
      "sum_rows_examined": 0,
      "avg_rows_sent": 1
    }
  ],
  "rows_examined_exceeding": []
}

Status Codes

Status Code

Description

200

Successful request

400

Bad request

500

Internal server error

Error Codes

See Error Codes.