# 查询GeminiDB Mongo数据库错误日志 - QueryingErrorLogsofaGeminiDBMongoInstance #### 功能介绍 查询GeminiDB Mongo数据库错误日志信息，支持日志关键字搜索。 #### 接口约束 - 不支持使用 \&\&、\|\|、AND、OR、NOT、\*、？、:、\>、\<、=、\>=、\<= 这些关键字来搜索日志。 - 查询到的慢日志数据在入参start_time和end_time的时间段内。 - 当次查询的日志起始行号line_num须从上一次查询的日志返回信息中获取，第一次查询可不传。 - 每页查询最大限制100条，错误日志最多保存30天。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | gaussdbfornosql:instance:listErrorLog | List | instance \* | - g:ResourceTag/\ - g:EnterpriseProjectId | nosql:instance:list | - | #### URI POST /v3/{project_id}/mongodb/instances/{instance_id}/error-logs 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一region下的project ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nosql/nosql_projectid.html)。 **约束限制：** 不涉及。 **取值范围：** 长度为32个字符，仅由英文字母和数字组成。 **默认取值：** 不涉及。 | | instance_id | 是 | String | **参数解释：** 实例ID。可以调用[查询实例列表和详情 - QueryingInstancesandDetails](https://support.huaweicloud.com/api-nosql/nosql_05_0016.html)接口获取。如果未申请实例，可以调用[创建实例 - CreatinganInstance](https://support.huaweicloud.com/api-nosql/nosql_05_0014.html)接口创建。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | start_time | 是 | String | **参数解释：** 查询错误日志的开始时间。 **约束限制：** 开始时间不得早于当前时间30天，且不得与结束时间相同。end_time必须晚于start_time。 格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | end_time | 是 | String | **参数解释：** 查询错误日志的结束时间。 **约束限制：** 结束时间不能晚于当前时间，且不能与开始时间相同，end_time 必须晚于 start_time。 格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | limit | 是 | Integer | **参数解释：** 表示每次查询的日志条数，单位：条。 **约束限制：** 不涉及。 **取值范围：** 1\~100。 **默认取值：** 不涉及。 | | line_num | 否 | String | **参数解释：** 日志单行序列号，当次查询从line_num的下一条日志开始查询，不包含当前line_num日志。 **约束限制：** 第一次查询时不需要此参数，下一次查询时需要使用，可从上一次查询的返回信息中获取。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | severity | 否 | String | **参数解释：** 日志级别。 **约束限制：** 不涉及。 **取值范围：** - Warning：警告级别的日志。 - Error：错误级别的日志。 **默认取值：** 不传入该参数表示查询所有日志级别的日志。 | | node_id | 否 | String | **参数解释：** 节点ID。具体取值请参考[表11](https://support.huaweicloud.com/api-nosql/nosql_05_0016.html#nosql_05_0016__response_ListInstancesNodeResult)中的"id"。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不传入该参数表示查询实例下所有允许查询的节点。 | | keywords | 否 | Array of strings | **参数解释：** 根据多个关键字搜索日志全文，表示同时匹配所有关键字。 **约束限制：** - 最多支持10个关键字。 - 每个关键字最大长度不超过512个字符。 | #### 响应参数 **状态码： 200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_logs | Array of [表5] objects | **参数解释：** 错误日志具体信息。 | 表5MongodbErrorLogDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | node_name | String | **参数解释：** 节点名称。 **取值范围：** 不涉及。 | | node_id | String | **参数解释：** 节点ID。 **取值范围：** 不涉及。 | | raw_message | String | **参数解释：** 描述信息。 **取值范围：** 不涉及。 | | severity | String | **参数解释：** 日志级别。 **取值范围：** - Warning：警告级别的日志。 - Error：错误级别的日志。 | | log_time | String | **参数解释：** 日志产生时间，UTC时间。 格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 **取值范围：** 不涉及。 | | 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" } ] } ``` #### 状态码 请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。