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	Explanation: Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints: None Value range: The value can contain 32 characters. Only letters and digits are allowed. Default value: None
instance_id	Yes	String	Explanation: Instance ID, which uniquely identifies an instance. Constraints: None Value range: The value can contain 36 characters with a suffix of in07. Only letters and digits are allowed. Default value: None

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Explanation: User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the token value. Constraints: None Value range: None Default value: None
X-Language	No	String	Explanation: Request language type. Constraints: None Value range: en-us zh-cn Default value: en-us

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
node_id	Yes	String	Explanation: Node ID. Constraints: None Value range: The value can contain 36 characters, starting with a UUID and ending with no07. Only letters and digits are allowed. Default value: None
start_time	Yes	String	Explanation: 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: None Value range: The time is earlier than the current time. Default value: None
end_time	Yes	String	Explanation: 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: None Value range: The time is later than the start time and earlier than the current time. Default value: None
limit	Yes	Integer	Explanation: Number of records to be queried. Constraints: None Value range: 1–5000 Default value: None
line_num	No	String	Explanation: 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: None Value range: The value is a string of 13 digits. Default value: None
operate_type	No	String	Explanation: SQL statement type. Constraints: None Value 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: None
database	No	String	Explanation: Database that slow query logs belong to. Constraints: None Value range: None Default value: None

Response Parameters

Status code: 200

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

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

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
  } ]
}