文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 获取日志信息/ 查询慢日志
更新时间：2024-08-09 GMT+08:00
查看PDF
分享

查询慢日志

功能介绍

查询实例的慢日志数据。

调试

您可以在API Explorer中调试该接口。

接口约束

该接口仅支持MySQL和PostgreSQL数据库引擎。

对于MySQL慢日志，如果SQL语句单行长度超过10KB或总行数超过200行，当前会对此类语句进行截断。查看慢日志明细时，SQL语句可能为特殊处理后的不完整语句，仅供参考。

URI

  • URI格式

    POST /v3/{project_id}/instances/{instance_id}/slow-logs

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    参数解释：

    租户在某一Region下的项目ID。

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

    约束限制：

    不涉及。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

    instance_id

    是

    参数解释：

    要查询的实例ID。

    约束限制：

    不涉及。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

请求消息

表2 参数说明

名称

是否必选

参数类型

说明

start_time

是

String

参数解释：

开始日期。

约束限制：

不涉及。

取值范围：

格式为“yyyy-mm-ddThh:mm:ssZ”。

其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。开始时间不能早于当前时间一个月之前。

默认取值：

不涉及。

end_time

是

String

参数解释：

结束时间。

约束限制：

不涉及。

取值范围：

格式为“yyyy-mm-ddThh:mm:ssZ”。

其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。只能查询当前时间前一个月内的慢日志。

默认取值：

不涉及。

type

否

String

参数解释：

语句类型。

约束限制：

不涉及。

取值范围：

取空值，表示查询所有语句类型。

枚举值：

  • INSERT
  • UPDATE
  • SELECT
  • DELETE
  • CREATE

默认取值：

不涉及。

line_num

否

String

参数解释：

日志单行序列号。

约束限制：

第一次查询时不需要此参数，后续分页查询时需要使用，可从上次查询的返回信息中获取。

取值范围：

line_num应在start_time和end_time之间。

默认取值：

不涉及。

limit

否

Integer

参数解释：

每页多少条记录（查询结果）。

约束限制：

不涉及。

取值范围：

取整数1~100。

默认取值：

不填时默认为10。

search_type

否

String

参数解释：

搜索方式。配合line_num使用。

约束限制：

不涉及。

取值范围：

  • forwards：以line_num为起点，向前搜索。
  • backwards：以line_num为起点，向后搜索。

默认取值：

forwards

database

否

String

参数解释：

数据库名称。

约束限制：

数据库名称不支持包含特殊字符 < > & 等的搜索。

取值范围：

不涉及。

默认取值：

不涉及。

请求示例

查询慢日志数据，每页10条记录。 
POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/slow-logs
{
    "start_time":"2023-01-02T23:58:57+0000",
    "end_time":"2023-01-06T01:47:20+0000",
    "limit":10,
    "line_num":"1672908793000000000"
}

响应消息

  • 正常响应要素说明
    表3 要素说明

    名称

    参数类型

    说明

    slow_log_list

    Array of objects

    参数解释：

    日志数据集合。

    详情请参见表4。

    long_query_time

    String

    参数解释：

    当前慢日志阈值时间。

    取值范围：

    不涉及。
    表4 slow_log_list字段数据结构说明

    名称

    参数类型

    说明

    count

    String

    参数解释：

    执行次数。

    取值范围：

    不涉及。

    time

    String

    参数解释：

    执行时间。

    取值范围：

    不涉及。

    lock_time

    String

    参数解释：

    等待锁时间。仅MySQL支持。

    取值范围：

    不涉及。

    rows_sent

    String

    参数解释：

    结果行数量。仅MySQL支持。

    取值范围：

    不涉及。

    rows_examined

    String

    参数解释：

    扫描的行数量。仅MySQL支持。

    取值范围：

    不涉及。

    database

    String

    参数解释：

    所属数据库。数据库名称如果包含特殊字符 < > ' 等，特殊字符会被转义处理。

    取值范围：

    不涉及。

    users

    String

    参数解释：

    账号。

    取值范围：

    不涉及。

    query_sample

    String

    参数解释：

    执行语法。慢日志默认脱敏显示，如需明文显示，请联系客服人员申请。

    取值范围：

    不涉及。

    type

    String

    参数解释：

    语句类型。

    取值范围：

    不涉及。

    start_time

    String

    参数解释：

    发生时间，UTC时间。

    取值范围：

    不涉及。

    client_ip

    String

    参数解释：

    IP地址。

    取值范围：

    不涉及。

    line_num

    String

    参数解释：

    日志单行序列号。

    取值范围：

    不涉及。
  • 正常响应样例 
    {
  "slow_log_list" : [ { 
    "count" : "1", 
    "time" : "1.04899 s", 
    "lock_time" : "0.00003 s", 
    "rows_sent" : "0", 
    "rows_examined" : "0", 
    "database" : "test_db", 
    "users" : "root", 
    "query_sample" : "INSERT INTO time_zone_name (Name, Time_zone_id) VALUES (N, @time_zone_id);", 
    "type" : "INSERT", 
    "start_time" : "2018-08-06T10:41:14", 
    "client_ip" : "192.*.*.1", 
    "line_num" : "1595659490239433658" 
  } ], 
  "long_query_time" : "1" 
}
  • 异常响应

    请参见异常请求结果。

状态码

错误码

请参见错误码。

父主题： 获取日志信息

相关文档