Help Center/ Distributed Database Middleware/ API Reference (Kuala Lumpur Region)/ Monitoring Management/ Monitoring Slow SQL Logs
Updated on 2022-08-17 GMT+08:00
View PDF

Monitoring Slow SQL Logs

Function

This API is used to query information about 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?curPage={curPage}&perPage={perPage}&startDate={startDate}&endDate={endDate}
Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

instance_id

Yes

String

DDM instance ID

curPage

Yes

String

Number of records displayed on each page. The start value cannot be less than 0.

perPage

Yes

String

Page size (number of records on each page).

startDate

Yes

String

Start time in UTC, accurate to milliseconds

endDate

Yes

String

End time in UTC, accurate to milliseconds

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

totalRecord

Integer

Number of slow SQL logs

slowLogList

Array of SlowLogList objects

Information about slow SQL logs
Table 4 SlowLogList

Parameter

Type

Description

users

String

Username of the DDM account for executing the slow SQL statement

database

String

Name of the schema that the slow SQL statement is executed for

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 database that the slow SQL statement is executed for

rowsExamined

String

Number of rows affected by the SQL statements that take a long time to execute

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Status code: 500

Table 6 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

OK

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

Status code: 400

bad request

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

Status code: 500

server error

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

Status Codes

Status Code

Description

200

OK

400

bad request

500

server error

Error Codes

For details, see Error Codes.

Parent topic: Monitoring Management