文档数据库 MongoDB 版
文档数据库 MongoDB 版
文档指南
请输入
- 文档首页
文档数据库 MongoDB 版API 参考日志管理DescribeNormalLogs
复制全文
下载 pdfDescribeNormalLogs
文档反馈
问问助手调用 DescribeNormalLogs 接口查询目标 MongoDB 实例在指定时间段内的运行日志或错误日志信息。
请求类型
同步请求。
注意事项
- 当前仅支持查看最近 7 天内的运行日志或错误日志详情。
- DescribeNormalLogs 为流式接口，支持分页查询机制。若您实例中的日志记录较多，通常需要调用多次该接口才能获取完整的日志。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
InstanceId String 必选 示例值：mongo-replica-e405f8e2f8e2
实例 ID。
说明
Limit Long 必选 示例值：10
每页记录数，取值范围为 1~1000。
Context String 可选 示例值：0,1749808482010,210209079374,618991
日志记录查询结果的分页查询凭证，用于标记分页位置。
说明
- DescribeNormalLogs 为流式接口，支持分页查询机制。若您实例中的日志记录较多，通常需要调用多次该接口才能获取完整的日志。
- 您可以根据返回参数 ListOver 的值来确定是否还有未加载的日志记录，并结合 Context 分页查询凭证分段获取：
- 若 ListOver 的值为 false，表示还有符合查询条件的日志记录未加载完，您可以再次调用 DescribeNormalLogs 接口，并使用上一次接口调用时返回参数中的 Context 所标记的分页位置往后查询剩余的日志记录。
- 若 ListOver 的值为 true，表示已加载完全部符合查询条件的日志记录。
PodName String 必选 示例值：mongo-replica-e405f8e2****-0
需要查询日志信息的节点 ID。
说明
- 副本集实例中的 NodeId 即为 PodName。
- 分片集实例中：
- ConfigServersId 即为 ConfigServer 节点的 PodName。
- MongosNodeId 即为 Mongos 节点的 PodName
- NodeId 即为 Shard 节点的 PodName。
Sort String 可选 示例值：DESC
将查询结果按照日志生成时间升序或降序排列。取值范围如下：
- DESC（默认）：降序排列。
- ASC：升序排列。
LogLevel String 可选 示例值：RunningLog
需要查询的日志级别。取值范围如下：
- ErrorLog（默认）：错误日志。
- RunningLog：运行日志。
Keys String 可选 示例值：warning error
检索关键词，用于检索包含关键词的运行日志或错误日志。
说明
- 若不传任何关键词，表示不用关键词对日志查询结果进行筛选。
- 支持同时传入多个关键词进行检索，多个关键词间用空格分隔，关键间为或关系。
- 例如，设置检索关键字 "Keys":"warning error"，表示检索包含了关键词 warning 或 error 的日志。
- 日志检索语句最长支持 4 KiB，检索语句中除了 Keys 传参部分还有一些系统预设字段，同时为提高检索效率和精度，建议不要传入过多关键词。
- 不支持传入预留关键词进行检索。关于预留关键词的更多信息，请参见日志检索预留关键词。
QueryStartTime String 可选 示例值：2025-06-12T08:30:00Z
查询开始时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。
说明
若该参数留空，实际查询开始时间默认为当前时间 1 小时前的时间（UTC）。
例如，当前时间为 2024 年 06 月 25 号 08:30:00（UTC），若 QueryStartTime 不填，那么实际查询开始时间为 2024-06-25T07:30:00Z。
QueryEndTime String 可选 示例值：2025-06-13T08:30:00Z
查询结束时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。
说明
- 若该参数留空，实际查询结束时间默认为当前时间（UTC）。
- 查询结束时间需晚于查询开始时间。
返回参数
Total Integer 示例值：10
查询结果总条目数。
Datas Object[] 示例值：
符合查询条件的日志列表详情。
LogType String 示例值：NETWORK
当前日志记录的日志类型。
Message String 示例值：end connection 172.30.***.***:37948 (14 connections now open)
当前日志记录的日志详细信息。
Connection String 示例值：conn171
当前日志记录的连接信息。
CreateTime String 示例值：2025-06-13T09:54:44Z
当前日志记录的生成时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。
Context String 示例值：0,1749808482010,210209079374,618991
日志记录查询结果的分页查询凭证，用于标记分页位置。
ListOver Boolean 示例值：false
日志内容是否已全部加载。取值范围如下：
- true：已全部加载。
- false：未全部加载。
说明
若 ListOver 返回 false，您可以再次调用 DescribeNormalLogs，并在请求参数中传入 Context所标记的分页位置，来查询未加载完的日志详情。
示例
请求示例 1
首次通过 DescribeNormalLogs 接口查询运行日志（RunningLog）详情，每页返回 10 条记录。
POST https://mongodb.cn-beijing.volcengineapi.com/?Action=DescribeNormalLogs&Version=2022-01-01 HTTP/1.1
Host: mongodb.cn-beijing.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": 10,
"InstanceId": "mongo-replica-e405f8e2****",
"PodName": "mongo-replica-e405f8e2****-0",
"QueryStartTime": "2025-06-12T09:54:45Z",
"QueryEndTime": "2025-06-13T09:54:45Z",
"Sort": "DESC",
"LogLevel": "RunningLog"
}
返回示例 1
{
"ResponseMetadata": {
"RequestId": "202306041104200100100232280022D31",
"Action": "DescribeNormalLogs",
"Version": "2022-01-01",
"Service": "mongodb",
"Region": "cn-beijing"
},
"Result": {
"Context": "0,1749808482010,210209079374,618991",
"Datas": [
{
"Connection": "conn171",
"CreateTime": "2025-06-13T09:54:44Z",
"LogType": "NETWORK",
"Message": "end connection 172.30.***.***:37948 (14 connections now open)"
},
{
"Connection": "conn170",
"CreateTime": "2025-06-13T09:54:44Z",
"LogType": "NETWORK",
"Message": "end connection 172.30.***.***:37940 (15 connections now open)"
},
{
"Connection": "listener",
"CreateTime": "2025-06-13T09:54:44Z",
"LogType": "NETWORK",
"Message": "start control connection, connectionCount is 16"
},
{
"Connection": "listener",
"CreateTime": "2025-06-13T09:54:44Z",
"LogType": "NETWORK",
"Message": "connection accepted from 172.30.***.***:37948 #171 (16 connections now open)"
},
{
"Connection": "listener",
"CreateTime": "2025-06-13T09:54:44Z",
"LogType": "NETWORK",
"Message": "start control connection, connectionCount is 15"
},
{
"Connection": "listener",
"CreateTime": "2025-06-13T09:54:44Z",
"LogType": "NETWORK",
"Message": "connection accepted from 172.30.***.***:37940 #170 (15 connections now open)"
},
{
"Connection": "conn169",
"CreateTime": "2025-06-13T09:54:42Z",
"LogType": "NETWORK",
"Message": "end connection 172.30.***.***:37694 (14 connections now open)"
},
{
"Connection": "conn168",
"CreateTime": "2025-06-13T09:54:42Z",
"LogType": "NETWORK",
"Message": "end connection 172.30.***.***:37688 (15 connections now open)"
},
{
"Connection": "listener",
"CreateTime": "2025-06-13T09:54:42Z",
"LogType": "NETWORK",
"Message": "start control connection, connectionCount is 16"
},
{
"Connection": "listener",
"CreateTime": "2025-06-13T09:54:42Z",
"LogType": "NETWORK",
"Message": "connection accepted from 172.30.***.***:37694 #169 (16 connections now open)"
}
],
"ListOver": false,
"Total": 10
}
}
请求示例 2
已通过 DescribeNormalLogs 接口查询了运行日志（RunningLog）详情，但查询结果并未全部加载（即接口返回结果中的 ListOver 为 false），您可以通过前一次返回结果中的分页标志符（即返回结果中的 Context 值，本文示例中该值为 0,1749808482010,210209079374,618991），再次调用该接口查询剩余的日志详情，每页记录数为 10。
POST https://mongodb.cn-beijing.volcengineapi.com/?Action=DescribeNormalLogs&Version=2022-01-01 HTTP/1.1
Host: mongodb.cn-beijing.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": 10,
"InstanceId": "mongo-replica-23fc14ece7ce",
"PodName": "mongo-replica-23fc14ece7ce-0",
"Context": "0,1749808482010,210209079374,618991",
"QueryStartTime": "2025-06-12T09:54:45Z",
"QueryEndTime": "2025-06-13T09:54:45Z",
"Sort": "DESC",
"LogLevel": "RunningLog"
}
返回示例 2
{
"ResponseMetadata": {
"RequestId": "202306041104200100100232280022D31",
"Action": "DescribeNormalLogs",
"Version": "2022-01-01",
"Service": "mongodb",
"Region": "cn-beijing"
},
"Result": {
"Context": "0,1749808479728,210209079360,618991",
"Datas": [
{
"Connection": "listener",
"CreateTime": "2025-06-13T09:54:42Z",
"LogType": "NETWORK",
"Message": "start control connection, connectionCount is 15"
},
{
"Connection": "listener",
"CreateTime": "2025-06-13T09:54:42Z",
"LogType": "NETWORK",
"Message": "connection accepted from 172.30.***.***:37688 #168 (15 connections now open)"
},
{
"Connection": "conn166",
"CreateTime": "2025-06-13T09:54:40Z",
"LogType": "NETWORK",
"Message": "end connection 172.18.***.***:59318 (14 connections now open)"
},
{
"Connection": "conn167",
"CreateTime": "2025-06-13T09:54:40Z",
"LogType": "NETWORK",
"Message": "end connection 172.18.***.***:59338 (15 connections now open)"
},
{
"Connection": "listener",
"CreateTime": "2025-06-13T09:54:40Z",
"LogType": "NETWORK",
"Message": "start control connection, connectionCount is 16"
},
{
"Connection": "listener",
"CreateTime": "2025-06-13T09:54:40Z",
"LogType": "NETWORK",
"Message": "connection accepted from 172.18.***.***:59338 #167 (16 connections now open)"
},
{
"Connection": "listener",
"CreateTime": "2025-06-13T09:54:40Z",
"LogType": "NETWORK",
"Message": "start control connection, connectionCount is 15"
},
{
"Connection": "listener",
"CreateTime": "2025-06-13T09:54:40Z",
"LogType": "NETWORK",
"Message": "connection accepted from 172.18.***.***:59318 #166 (15 connections now open)"
},
{
"Connection": "conn164",
"CreateTime": "2025-06-13T09:54:39Z",
"LogType": "NETWORK",
"Message": "end connection 172.18.***.***:58870 (15 connections now open)"
},
{
"Connection": "conn165",
"CreateTime": "2025-06-13T09:54:39Z",
"LogType": "NETWORK",
"Message": "end connection 172.18.***.***:59030 (14 connections now open)"
}
],
"ListOver": false,
"Total": 10
}
}
错误码
最近更新时间：2026.06.17 16:54:28
这个页面对您有帮助吗？
有用
有用
无用
无用