文档首页/ 分布式缓存服务 DCS/ API参考 (联盟区域) / API V2（推荐）/ 日志管理/ 查询慢日志
更新时间：2025-12-29 GMT+08:00
查看PDF
分享

查询慢日志

功能介绍

查询慢日志。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。可通过DCS控制台进入实例详情界面查看。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释：

偏移量，表示从此偏移量开始查询。

约束限制：

不涉及。

取值范围：

大于等于0。

默认取值：

0

limit

否

Integer

参数解释：

每页显示的条目数量。

约束限制：

不涉及。

取值范围：

1-1000

默认取值：

10

sort_key

否

String

参数解释：

返回结果按该关键字排序。

约束限制：

不涉及。

取值范围：

  • start_time：慢日志的开始时间。

  • duration：慢日志的耗时长短。

默认取值：

“start_time”

sort_dir

否

String

参数解释：

返回结果按照降序或升序排序。

约束限制：

不涉及。

取值范围：

  • desc：降序。

  • asc：升序。

默认取值：

“desc”

start_time

是

String

参数解释：

查询开始时间，时间为UTC时间的Unix时间戳。如：1598803200000。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

end_time

是

String

参数解释：

查询结束时间，时间为UTC时间的Unix时间戳。如：1599494399000。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

total_num

Integer

参数解释：

慢日志总数。

取值范围：

不涉及。

count

Integer

参数解释：

慢日志总数。

取值范围：

不涉及。

slowlogs

Array of SlowlogItem objects

参数解释：

慢日志列表。

取值范围：

不涉及。
表4 SlowlogItem

参数

参数类型

描述

id

Integer

参数解释：

慢日志的唯一标识。

取值范围：

不涉及。

command

String

参数解释：

慢命令。

取值范围：

不涉及。

start_time

String

参数解释：

执行开始时间，格式为“2020-06-19T07:06:07Z”。

取值范围：

不涉及。

duration

String

参数解释：

持续时间，单位是μs。

取值范围：

不涉及。

shard_name

String

参数解释：

慢命令所在的分片名称，仅在实例类型为集群时支持。

取值范围：

不涉及。

database_id

Integer

参数解释：

数据库ID，当前只对指定客户开放。

取值范围：

0-255。

username

String

参数解释：

操作慢日志的账号名称，当前只对指定客户开放。

取值范围：

不涉及。

node_role

String

参数解释：

节点类型。

取值范围：

不涉及。

client_ip

String

参数解释：

客户端IP地址。

取值范围：

不涉及。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

状态码：403

表7 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

状态码：404

表8 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

请求示例

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

响应示例

状态码：200

查询慢日志成功。

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

状态码：400

非法请求。

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

状态码

状态码

描述

200

查询慢日志成功。

400

非法请求。

401

认证信息非法。

403

请求被拒绝访问。

404

所请求的资源不存在。

500

内部服务错误。

错误码

请参见错误码。

父主题： 日志管理