文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 日志管理/ 查询数据库错误日志信息 - QueryingDatabaseErrorLogs
更新时间：2026-05-28 GMT+08:00
查看PDF
分享

查询数据库错误日志信息 - QueryingDatabaseErrorLogs

功能介绍

查询数据库错误日志，暂不支持关键字搜索。

接口约束

该接口支持GeminiDB Mongo数据库实例。

目前仅支持查询最近的2000条错误日志信息。

目前仅支持查询最近一个月内的错误日志信息。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbfornosql:instance:listErrorLog

    List

    instance *
    • g:ResourceTag/<tag-key>
    • g:EnterpriseProjectId

    nosql:instance:list

    -

URI

GET /v3/{project_id}/instances/{instance_id}/error-log

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

start_time

是

String

参数解释：

开始时间。

约束限制：

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

取值范围：

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

其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。

默认取值：

不涉及。

end_time

是

String

参数解释：

结束时间。

约束限制：

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

取值范围：

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

其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。

默认取值：

不涉及。

node_id

否

String

参数解释：

节点ID。具体取值请参考表10中的“id”。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不传入该参数表示查询实例下所有允许查询的节点。

type

否

String

参数解释：

语句类型。

约束限制：

不涉及。

取值范围：

  • Warning
  • Error

默认取值：

不传入该参数表示查询所有语句类型。

offset

否

Integer

参数解释：

索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。

约束限制：

必须为数字，不能为负数。

取值范围：

[0, 1999]。

默认取值：

默认为0（偏移0条数据，表示从第一条数据开始查询）。

limit

否

Integer

参数解释：

查询记录数。

约束限制：

limit 与 offset的和需要满足小于等于2000的条件。

取值范围：

[1, 100]。

默认取值：

默认10 （表示默认返回10条数据）。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

通过调用IAM服务获取用户Token接口获取。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码： 202

表4 响应Body参数

参数

参数类型

描述

total_count

Integer

参数解释：

总记录数。

取值范围：

不涉及。

error_log_list

Array of 表5 objects

参数解释：

错误日志列表。

取值范围：

不涉及。
表5 ErrorLogList

参数

参数类型

描述

node_name

String

参数解释：

节点名称。

取值范围：

不涉及。

level

String

参数解释：

日志级别。

取值范围：

不涉及。

time

String

参数解释：

发生时间，UTC时间。

取值范围：

不涉及。

content

String

参数解释：

日志内容。

取值范围：

不涉及。

请求示例

URI样例 
GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in10/error-log

响应示例

状态码： 202

Success

{ 
  "error_log_list" : [ { 
    "node_name" : "Test_replica_node_2", 
    "level" : "WARNING", 
    "time" : "2020-12-15T08:53:01.868+0000", 
    "content" : "W NETWORK  [LogicalSessionCacheReap] Unable to reach primary for set replica" 
  } ], 
  "total_count" : 1 
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 日志管理

相关文档