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

Dependencies

das::showCloudDBAInfo

Read

-

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
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	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are supported. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. You can obtain the instance ID from the instance list or instance details. Constraints N/A Range The value can contain 36 characters. Only letters and digits are allowed. Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
num	Yes	Integer	Definition Top N Constraints N/A Range [0, 2^31-1]. The actual value depends on the query result. Default Value N/A
start_at	Yes	Long	Definition Start time Constraints Unix timestamp, in milliseconds Range [0, 2^63 – 1]. The actual value depends on the query result. Default Value N/A
end_at	Yes	Long	Definition End time Constraints Unix timestamp, in milliseconds Range [0, 2^63 – 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	Definition Execution times
top_avg_query_time_slow_logs	Array of Table 5 objects	Definition Average execution duration list
top_max_query_time_slow_logs	Array of Table 6 objects	Definition Maximum execution duration list
rows_examined_exceeding	Array of Table 7 objects	Definition List of percentage of returned rows to scanned rows

**Table 4** top_execute_slow_logs
Parameter	Type	Description
template_id	String	Definition SQL template ID Range N/A
template	String	Definition SQL template Range N/A
databases	Array of strings	Definition Database name
times	Long	Definition Execution times Range N/A
avg_query_time	Double	Definition Average execution duration Range N/A
max_query_time	Double	Definition Maximum execution duration Range N/A
avg_rows_examined	Double	Definition Average rows scanned Range N/A
sum_rows_examined	Double	Definition Total rows scanned Range N/A
avg_rows_sent	Double	Definition Average rows returned Range N/A

**Table 5** top_avg_query_time_slow_logs
Parameter	Type	Description
template_id	String	Definition SQL template ID Range N/A
template	String	Definition SQL template Range N/A
databases	Array of strings	Definition Database name
times	Long	Definition Execution times Range N/A
avg_query_time	Double	Definition Average execution duration Range N/A
max_query_time	Double	Definition Maximum execution duration Range N/A
avg_rows_examined	Double	Definition Average rows scanned Range N/A
sum_rows_examined	Double	Definition Total rows scanned Range N/A
avg_rows_sent	Double	Definition Average rows returned Range N/A

**Table 6** top_max_query_time_slow_logs
Parameter	Type	Description
template_id	String	Definition SQL template ID Range N/A
template	String	Definition SQL template Range N/A
databases	Array of strings	Definition Database name
times	Long	Definition Execution times Range N/A
avg_query_time	Double	Definition Average execution duration Range N/A
max_query_time	Double	Definition Maximum execution duration Range N/A
avg_rows_examined	Double	Definition Average rows scanned Range N/A
sum_rows_examined	Double	Definition Total rows scanned Range N/A
avg_rows_sent	Double	Definition Average rows returned Range N/A

**Table 7** rows_examined_exceeding
Parameter	Type	Description
template_id	String	Definition SQL template ID Range N/A
template	String	Definition SQL template Range N/A
databases	Array of strings	Definition Database name
times	Long	Definition Execution times Range N/A
avg_query_time	Double	Definition Average execution duration Range N/A
max_query_time	Double	Definition Maximum execution duration Range N/A
avg_rows_examined	Double	Definition Average rows scanned Range N/A
sum_rows_examined	Double	Definition Total rows scanned Range N/A
avg_rows_sent	Double	Definition Average rows returned Range N/A

Example Requests

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

Example Responses

Status code: 200

Success

{
  "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	Success
400	Bad request
500	Internal server error

Error Codes

See Error Codes.

Parent topic: Intelligent O&M

Previous topic: Obtaining Information About a Single Instance Node

Next topic: Enabling or Disabling Collect All Query Logs and Collect Slow Query Logs