文档首页/ 云数据库 GeminiDB/ API参考/ API v3(推荐)/ 日志管理/ 查询GeminiDB Mongo数据库错误日志
更新时间:2023-12-14 GMT+08:00

查询GeminiDB Mongo数据库错误日志

功能介绍

查询GeminiDB Mongo数据库错误日志信息,支持日志关键字搜索。

接口约束

  • 不支持使用 &&、||、AND、OR、NOT、*、?、:、>、<、=、>=、<= 这些关键字来搜索日志。
  • 查询到的慢日志数据在入参start_time和end_time的时间段内。
  • 当次查询的日志起始行号line_num须从上一次查询的日志返回信息中获取,第一次查询可不传。
  • 每页查询最大限制100条,错误日志最多保存30天。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一region下的project ID。获取方法请参见获取项目ID

instance_id

String

实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

表3 请求Body参数

参数

是否必选

参数类型

描述

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

node_id

String

节点ID,取空值,表示查询实例下所有允许查询的节点。具体取值请参考表10中的“id”。

keywords

Array of strings

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

  • 最多支持10个关键字。
  • 每个关键字最大长度不超过512个字符。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

error_logs

Array of objects

错误日志具体信息。详情请参考表5

表5 MongodbErrorLogDetail

参数

参数类型

描述

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

日志单行序列号。

请求示例

POST https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/mongodb/instances/916de02c35fe4abaa3e707ebd916d3f8in10/error-logs 
 
{ 
  "start_time" : "2023-01-06T10:41:14+0800", 
  "end_time" : "2023-01-10T10:41:14+0800", 
  "limit" : 100, 
  "line_num" : "1595659490239433658", 
  "severity" : "Warning", 
  "node_id" : "dfe41edcb2a1483c96ddf61cc0cee237no10", 
  "keywords" : [ "error" ] 
}

响应示例

状态码: 200

Success

{ 
  "error_logs" : [ { 
    "node_name" : "test_replica_node_1", 
    "node_id" : "dfe41edcb2a1483c96ddf61cc0cee237no10", 
    "raw_message" : "W TEST [test001] test error log", 
    "severity" : "Warning", 
    "log_time" : "2023-01-09T12:55:39.398+0000", 
    "line_num" : "1595659490239433659" 
  } ] 
}

状态码

请参见状态码

错误码

请参见错误码