Querying Slow Query Logs

Function

This API is used to query slow query logs of a specified DB instance. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

POST /v3.1/{project_id}/instances/{instance_id}/slow-logs

**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 contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
node_id	Yes	String	Definition Node ID. Constraints N/A Range The value contains 36 characters, starting with a UUID and ending with no07. Only letters and digits are allowed. Default Value N/A
start_time	Yes	String	Definition Start time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100. Constraints N/A Range The time is earlier than the current time. Default Value N/A
end_time	Yes	String	Definition End time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100. Constraints N/A Range The time is later than the start time and earlier than the current time. Default Value N/A
limit	Yes	Integer	Definition Number of records to be queried. Constraints N/A Range 1–5000 Default Value N/A
line_num	No	String	Definition Sequence number of a log event. This parameter is not required for the first query, but is required for subsequent pagination queries. The value can be obtained from the response of the last query. Constraints N/A Range The value is a string of 13 digits. Default Value N/A
operate_type	No	String	Definition SQL statement type. Constraints N/A Range If this parameter is left blank or set to ALL, all statement types are queried. You can also specify the following log types: INSERT UPDATE SELECT DELETE ALTER DROP CREATE Default Value N/A
database	No	String	Definition Database that slow query logs belong to. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameter
Parameter	Type	Description
slow_log_list	Array of LtsLogSlowDetail objects	Definition Slow query logs.

**Table 5** LtsLogSlowDetail
Parameter	Type	Description
node_id	String	Definition Node ID. Range The value contains 36 characters, starting with a UUID and ending with no07. Only letters and digits are allowed.
count	String	Definition Number of executions. Range N/A
time	String	Definition Execution time. Range N/A
lock_time	String	Definition Lock wait time. Range N/A
rows_sent	String	Definition Number of sent rows. Range N/A
rows_examined	String	Definition Number of scanned rows. Range N/A
database	String	Definition Database that slow query logs belong to. Range gaussdb-mysql
users	String	Definition Account name. Range N/A
query_sample	String	Definition Execution syntax. Range N/A
type	String	Definition Statement type. Range INSERT UPDATE SELECT DELETE ALTER DROP CREATE
start_time	String	Definition Start time in the UTC format. Range N/A
client_ip	String	Definition IP address. Range N/A
line_num	String	Definition Sequence number of a log event. Range N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Querying slow query logs

POST https://{endpoint}/v3.1/056538411200d4cd2f79c003c7606412/instances/096c0fc43e804757b59946b80dc27f8bin07/slow-logs
{
  "start_time" : "2022-11-20T00:00:00+0800",
  "end_time" : "2022-11-29T00:00:00+0800",
  "node_id" : "cc07c60e94ec4575989840e648fb4f66no07",
  "limit" : 10,
  "line_num" : 1669344916000
}

Example Response

Status code: 200

Success.

{
  "slow_log_list" : [ {
    "node_id" : "cc07c60e94ec4575989840e648fb4f66no07",
    "count" : 1,
    "time" : "1.04899 s",
    "lock_time" : "0.00003 s",
    "rows_sent" : 0,
    "rows_examined" : 0,
    "database" : "gaussdb-mysql",
    "users" : "root",
    "query_sample" : "INSERT INTO time_zone_name (Name, Time_zone_id) VALUES (N @time_zone_id);",
    "type" : "INSERT",
    "start_time" : "2022-11-25T10:55:16.000",
    "client_ip" : "192.*.*.1",
    "line_num" : 1669344916000
  } ]
}