文档首页/文档数据库服务 DDS/API参考（联盟区域）/API v3（推荐）/获取日志信息/查询数据库错误日志（新版）
更新时间：2026-01-07 GMT+08:00
查看PDF
分享

查询数据库错误日志（新版）

接口说明

查询数据库错误日志信息。

约束说明

  • 不支持使用 &&、||、AND、OR、NOT、*、？、:、>、<、=、>=、<=这些关键字来搜索日志。
  • 每页查询最大限制100条，日志最多保存30天。

URI

  • URI格式

    POST https://{Endpoint}/v3.1/{project_id}/instances/{instance_id}/error-logs

表1 路径参数

名称

类型

IN

是否必选

描述

project_id

string

path

是

租户在某一region下的project ID。请参考获取项目ID章节获取项目编号。

instance_id

string

path

是

实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

请求参数

表2 请求Header参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

用户Token。

表3 参数说明

名称

类型

是否必选

说明

start_time

String

是

开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。

其中，T指某个时间的开始；Z指时区偏移量。

注意：

开始时间不得早于当前时间30天。

end_time

String

是

结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。

其中，T指某个时间的开始，Z指时区偏移量。

说明：

结束时间不能晚于当前时间。

limit

Integer

是

表示每次查询的日志条数，最大限制100条。

line_num

String

否

日志单行序列号，第一次查询时不需要此参数，下一页查询时需要使用，可从上一次查询的返回信息中获取。 说明：当次查询从line_num的下一条日志开始查询，不包含当前line_num日志。

severity

String

否

日志级别，取空值表示查询所有日志级别。枚举值：

  • WARNING
  • ERROR

search_type

String

否

日志查询方式，需结合line_num使用，以line_num的日志为起始点：

  • 取值"backwards"时，表示查询上一页limit大小的日志。
  • 取值"forwards"时，表示查询下一页limit大小的日志。
  • 不传默认"forwards"。

枚举值：

  • backwards
  • forwards

node_id

String

否

节点ID，取空值，表示查询实例下所有允许查询的节点。 使用请参考表9的“id”。允许查询的节点如下：

  • 集群实例下面的 shard节点。
  • 副本集实例下面的所有节点。

keywords

Array of strings

否

根据多个关键字搜索日志全文，表示同时匹配所有关键字。

  • 只支持关键字前缀模糊搜索，最多支持10个关键字。
  • 每个关键字最大长度不超过512个字符。
  • 请求示例 
    { 
  "start_time" : "2023-01-06T10:41:14+0800", 
  "end_time" : "2023-01-09T13:41:14+0800", 
  "limit" : 100, 
  "line_num" : "1595659490239433658", 
  "severity" : "Warning", 
  "search_type" : "forwards",
  "node_id" : "dbd0b65ed0c34125a0b04d4e5ba67e66no02",
  "keywords" : ["Unable", "NETWORK"] 
}

响应参数

表4 参数说明

名称

参数类型

说明

error_logs

Array of objects

错误日志具体信息。

详情请参见表5。

表5 error_log_list字段数据结构说明

名称

参数类型

说明

node_name

String

节点名称。

node_id

String

节点ID。

raw_message

String

描述信息。

severity

String

日志级别。

log_time

String

日志产生时间，UTC时间。格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量。

line_num

String

日志单行序列号。

  • 响应示例 
    { 
  "error_logs" : [ { 
    "node_name" : "Test_replica_node_2", 
    "node_id" : "dbd0b65ed0c34125a0b04d4e5ba67e66no02", 
    "raw_message" : "W NETWORK  [ShardServerCatalogCacheLoader-214] Unable to reach primary for set shard_2", 
    "severity" : "Warning", 
    "log_time" : "2023-01-09T12:55:39.398+0000", 
    "line_num" : "1595659490239433659" 
  } ] 
}

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题：获取日志信息