Updated on 2025-05-13 GMT+08:00

Querying the Slow Log

Function

This API is used to query slow logs.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Parameter description:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

instance_id

Yes

String

Parameter description:

Instance ID. It can be viewed on the instance details page on the DCS console.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Parameter description:

Offset, which is the position where the query starts.

Constraints:

N/A.

Value range:

≥ 0

Default value:

0

limit

No

Integer

Parameter description:

Number of records displayed on each page.

Constraints:

N/A.

Value range:

1–1,000

Default value:

10

sort_key

No

String

Parameter description:

Keyword based on which the returned results are sorted.

Constraints:

N/A.

Value range:

  • start_time: start time of the slow query log.

  • duration: duration of the slow query log.

Default value:

start_time

sort_dir

No

String

Parameter description:

Result sorting order.

Constraints:

N/A.

Value range:

  • desc: descending order

  • asc: ascending order

Default value:

desc

start_time

Yes

String

Parameter description:

Query start time (UTC). Example: 1598803200000.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

end_time

Yes

String

Parameter description:

Query end time (UTC). Example: 1599494399000.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total_num

Integer

Parameter description:

Total number of slow logs.

Value range:

N/A.

count

Integer

Parameter description:

Total number of slow logs.

Value range:

N/A.

slowlogs

Array of SlowlogItem objects

Parameter description:

Slow log list.

Value range:

N/A.

Table 4 SlowlogItem

Parameter

Type

Description

id

Integer

Parameter description:

Unique ID of a slow log.

Value range:

N/A.

command

String

Parameter description:

Slow command.

Value range:

N/A.

start_time

String

Parameter description:

Execution start time. Example: 2020-06-19T07:06:07Z.

Value range:

N/A.

duration

String

Parameter description:

Duration, in ms.

Value range:

N/A.

shard_name

String

Parameter description:

Name of the shard where the slow command is executed. This parameter is supported only when the instance type is cluster.

Value range:

N/A.

database_id

Integer

Parameter description:

Database ID, which is available only to some customers.

Value range:

0-255

username

String

Parameter description:

Account name that can operate on slow logs. This parameter is available only to some customers.

Value range:

N/A.

node_role

String

Parameter description:

Node type.

Value range:

N/A

client_ip

String

Parameter description:

Client IP address.

Value range:

N/A

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

Extended error information. This parameter is not used currently and is set to null.

Value range:

N/A.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

Extended error information. This parameter is not used currently and is set to null.

Value range:

N/A.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

Extended error information. This parameter is not used currently and is set to null.

Value range:

N/A.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

Extended error information. This parameter is not used currently and is set to null.

Value range:

N/A.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

Extended error information. This parameter is not used currently and is set to null.

Value range:

N/A.

Example Requests

GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/slowlog?start_time=1598803200000&end_time=1599494399000

Example Responses

Status code: 200

Slow logs queried successfully.

{
  "total_num" : 1,
  "count" : 1,
  "slowlogs" : [ {
    "id" : 1,
    "start_time" : "2020-06-19T07:06:07Z",
    "command" : "SLOWLOG GET 128",
    "duration" : "17",
    "shard_name" : "group-0",
    "database_id" : 1,
    "username" : "default",
    "node_role" : "master",
    "client_ip" : "127.0.0.1:6379"
  } ]
}

Status code: 400

Invalid request.

{
  "error_code" : "DCS.4800",
  "error_msg" : "Invalid start_time in the request."
}

Status Codes

Status Code

Description

200

Slow logs queried successfully.

400

Invalid request.

401

Invalid authentication information.

403

The request is rejected.

404

The requested resource is not found.

500

Internal service error.

Error Codes

See Error Codes.