You need to enable JavaScript to run this app.
导航
文档数据库 MongoDB 版
  • 文档首页
    • /
  • 文档数据库 MongoDB 版

DescribeNormalLogs

最近更新时间：2024.04.26 11:07:55

首次发布时间：2024.04.26 11:07:55

我的收藏

调用 DescribeNormalLogs 接口查看指定实例在指定时间段内的运行日志或错误日志列表。

请求类型

同步请求。

注意事项

当前仅支持查看最近 7 天内的运行日志或错误日志详情。

请求参数

参数类型是否必选示例值描述

InstanceId

String

是

mongo-replica-e405f8e2****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息，包括实例 ID。

LimitLong是10每页记录数，取值范围为 1~1000。
StartTimeLong是1712728800查询开始时间，格式为 Unix 时间戳，单位：秒。

EndTime

Long

是

1712728860

查询结束时间，格式为 Unix 时间戳，单位：秒。

说明

查询结束时间需晚于查询开始时间。

PodName

String

是

mongo-replica-e405f8e2****-1

需要查询日志信息的节点 ID。

说明

您可以调用 DescribeDBInstanceDetail 接口获取指定实例的详细信息，包括实例中各节点的节点 ID 。其中：

  • 副本集实例中的 NodeId 即为 PodName。
  • 分片集实例中：
    • ConfigServersId 即为 ConfigServer 节点的 PodName。
    • MongosNodeId 即为 Mongos 节点的 PodName
    • NodeId 即为 Shard 节点的 PodName。

Sort

String

否

ASC

将查询结果按照日志生成时间升序或降序排列。取值范围如下：

  • DESC（默认）：降序排列。
  • ASC：升序排列。

LogLevel

String

否

RunningLog

需要查询的日志级别。取值范围如下：

  • ErrorLog：错误日志。
  • RunningLog：运行日志。

Context

String

否

[1712731868000000,3559571755,2097165,null]

日志记录查询结果的上下文，需要加载更多日志记录时使用。

说明

调用 DescribeNormalLogs 接口后，您可以根据返回参数 ListOver 的值来确定是否还有未加载的日志记录：

  • 若 ListOver 的值为 false，表示还有符合查询条件的日志记录未加载完，您可以再次调用 DescribeNormalLogs 接口，并使用上一次接口调用时返回参数中的 Context 值来查看剩余的日志记录。
  • 若 ListOver 的值为 true，表示已加载完全部符合查询条件的日志记录。

返回参数

参数类型示例值描述
TotalInteger1查询结果总条目数。
DatasArray of DBLog请参见返回示例。符合查询条件的日志列表详情。
ContextString[1712731868000000,3559571755,2097165,null]日志记录查询结果的上下文，需要加载更多日志记录时使用。

ListOver

Boolean

true

日志内容是否已全部加载。取值范围如下：

  • true：已全部加载。
  • false：未全部加载。

说明

若 ListOver 返回 false，您可以再次调用 DescribeNormalLogs，并在请求参数中传入 Context 返回的值，来查询未加载完的日志详情。

DBLog

参数类型示例值描述
LogTypeStringNETWORK当前日志记录的日志类型。
MessageStringSuccessfully authenticated as principal mgr on admin from client 127.0.0.1:4****当前日志记录的日志详细信息。
ConnectionStringconn197381当前日志记录的连接信息。
CreateTimeString2024-04-10T17:50:59.653+0800当前日志记录的生成时间，格式为 yyyy-MM-ddTHH:mm:ss.SSSZ（UTC+8）。

示例

请求示例

POST https://mongodb.volcengineapi.com/?Action=DescribeNormalLogs&Version=2022-01-01 HTTP/1.1
Host: mongodb.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "Limit": 20,
    "StartTime": 1712728800,
    "EndTime": 1712728860,
    "Sort": "ASC",
    "InstanceId": "mongo-replica-e405f8e2****",
    "PodName": "mongo-replica-46cb08bc****-1",
    "Context": "[1712731868000000,3559571755,2097165,null]",
    "LogLevel": "RunningLog"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "DescribeNormalLogs",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": {
        "Total": 1,
        "Datas": [
            {
                "LogType": "NETWORK",
                "CreateTime": "2024-04-10T17:50:59.653+0800",
                "Message": "Successfully authenticated as principal mgr on admin from client 127.0.0.1:4****",
                "Connection": "conn197381"
            }
        ],
        "Context": "[1712731868000000,3559571755,2097165,null]",
        "ListOver": true
    }
}