On this page

Function
Constraints
URI
Request Parameters
Response Parameters
Example Request
Example Response
Status Codes
Error Codes

Show all

Help Center/ Distributed Database Middleware/ API Reference/ APIs (Recommended)/ Monitoring/ Monitoring Slow Query Logs

Monitoring Slow Query Logs

Updated on 2022-09-15 GMT+08:00

View PDF

Function

This API is used to query the SQL statements that take a long time to execute on the DDM instance within a specified time range.

Constraints

None

URI

GET /v2/{project_id}/instances/{instance_id}/slowlog

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
instance_id	Yes	String	DDM instance ID

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
curPage	Yes	String	Which page the server starts returning items. The start value cannot be less than 0.
perPage	Yes	String	Number of records displayed on each page
startDate	Yes	String	Start time in UTC, accurate to milliseconds
endDate	Yes	String	End time in UTC, accurate to milliseconds The interval between the start time and the end time must be no more than 7 days.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
totalRecord	Integer	Number of slow query logs
slowLogList	Array of SlowLogList objects	Information about slow query logs

**Table 5** SlowLogList
Parameter	Type	Description
users	String	Username of the DDM account for executing the slow SQL statement
database	String	Name of the schema where the slow SQL statement is executed
querySample	String	Syntax for executing the slow SQL statement
logTime	String	Time when the slow SQL statement starts to be executed
time	String	Time for a SQL statement to execute, accurate to milliseconds
shards	String	Name of the physical shard
rowsExamined	String	Number of rows affected by the SQL statements that take a long time to execute
host	String	Client IP address. This IP address may involve personal data. Anonymizing the IP address data is recommended.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
errCode	String	Service error code
externalMessage	String	Error message

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
errCode	String	Service error code
externalMessage	String	Error message

Example Request

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/slowlog?curPage={curPage}&perPage={perPage}&startDate={startDate}&endDate={endDate}

Example Response

Status code: 200

{
  "totalRecord" : 2,
  "slowLogList" : [ {
    "users" : "testddm",
    "database" : "test1",
    "querySample" : "select id, sleep(3) from test",
    "logTime" : "2021-04-26T02:40:21",
    "time" : "12002",
    "shards" : "test1_0000",
    "rowsExamined" : "4",
    "host" : "192.168.16.18"
  } ]
}

Status code: 400

bad request

{
  "externalMessage" : "Parameter error.",
  "errCode" : "DBS.280001"
}

Status code: 500

server error

{
  "externalMessage" : "Server failure.",
  "errCode" : "DBS.200412"
}

Status Codes

Status Code	Description
200	OK
400	bad request
500	server error

Error Codes

For details, see Error Codes.

Parent topic: Monitoring

Previous topic: Monitoring

Next topic: APIs (Unavailable Soon)

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel