You need to enable JavaScript to run this app.
导航
文档数据库 MongoDB 版
  • 文档首页
    • /文档数据库 MongoDB 版/API 参考/日志管理/DescribeSlowLogs
DescribeSlowLogs
最近更新时间：2025.06.16 21:22:22首次发布时间：2024.04.26 11:07:55
我的收藏
有用
有用
无用
无用

调用 DescribeSlowLogs 接口查询目标 MongoDB 实例在指定时间内的慢日志信息。

请求类型

同步请求。

注意事项

  • 当前仅支持查看最近 7 天内的慢日志详情。
  • DescribeSlowLogs 为流式接口，支持分页查询机制。若您实例中的慢日志记录较多，通常需要调用多次该接口才能获取完整的慢日志。

请求参数

参数
类型
是否必选
示例值
描述
InstanceId
String
是
mongo-replica-46cb08bc****

实例 ID。

说明

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

Limit
Long
是
10
每页记录数，取值范围为 1~1000。
Context
String
否
0,1749812066000,30877190347,2503067

慢日志记录查询结果的分页查询凭证，用于标记分页位置。

说明

  • DescribeSlowLogs 为流式接口，支持分页查询机制。若您实例中的慢日志记录较多，通常需要调用多次该接口才能获取完整的慢日志。
  • 您可以根据返回参数 ListOver 的值来确定是否还有未加载的慢日志记录，并结合 Context 分页查询凭证分段获取：
    • 若 ListOver 的值为 false，表示还有符合查询条件的慢日志记录未加载完，您可以再次调用 DescribeSlowLogs 接口，并使用上一次接口调用时返回参数中的 Context 所标记的分页位置往后查询剩余的慢日志记录。
    • 若 ListOver 的值为 true，表示已加载完全部符合查询条件的慢日志记录。
PodName
String
是
mongo-replica-46cb08bc****-1

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

说明

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

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

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

  • DESC（默认）：降序排列。
  • ASC：升序排列。
DBName
String
否
doctest
慢日志所在的数据库。
Keys
String
否
warning error

检索关键词，用于检索包含关键词的慢日志。

说明

  • 若不传任何关键词，表示不用关键词对慢日志查询结果进行筛选。
  • 支持同时传入多个关键词进行检索，多个关键词间用空格分隔，关键间为或关系。
    例如，设置检索关键字 "Keys":"warning error"，表示检索包含了关键词 warning 或 error 的日志。
  • 日志检索语句最长支持 4 KiB，检索语句中除了 Keys 传参部分还有一些系统预设字段，同时为提高检索效率和精度，建议不要传入过多关键词。
  • 不支持传入预留关键词进行检索。关于预留关键词的更多信息，请参见日志检索预留关键词。
QueryStartTime
String
否
2025-06-12T11:34:30Z

查询开始时间，格式为 yyyy-MM-ddTHH:mmZ（UTC）。

说明

若该参数留空，实际查询开始时间默认为当前时间 1 小时前的时间（UTC）。
例如，当前时间为 2024 年 06 月 25 号 08:30:00（UTC），若 QueryStartTime 不填，那么实际查询开始时间为 2024-06-25T07:30:00Z。

QueryEndTime
String
否
2025-06-13T11:34:30Z

查询结束时间，格式为 yyyy-MM-ddTHH:mmZ（UTC）。

说明

  • 若该参数留空，实际查询结束时间默认为当前时间（UTC）。
  • 查询结束时间需晚于查询开始时间。

返回参数

参数
类型
示例值
描述
Total
Integer
1
查询结果总条目数。
Datas
Object[]
符合查询条件的慢日志列表详情。
Context
String
0,1749812066000,30877190347,2503067
慢日志记录查询结果的分页查询凭证，用于标记分页位置。
ListOver
Boolean
false

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

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

说明

若 ListOver 返回 false，您可以再次调用 DescribeSlowLogs，并在请求参数中传入 Context 所标记的分页位置，来查询未加载完的慢日志详情。

示例

请求示例 1

首次通过 DescribeSlowLogs 接口查询慢日志详情，每页返回 10 条记录。

POST https://mongodb.cn-beijing.volcengineapi.com/?Action=DescribeSlowLogs&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****-1",
    "DBName": "doctest",
    "QueryStartTime": "2025-06-12T11:34:30Z",
    "QueryEndTime": "2025-06-13T10:55:30Z",
    "Sort": "DESC"
}

返回示例 1

{
    "ResponseMetadata": {
        "RequestId": "20230604110420010010023228002****",
        "Action": "DescribeSlowLogs",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": {
        "Context": "0,1749812066000,30877190347,2503067",
        "Datas": [
            {
                "ClientIP": "100.67.***.***",
                "DBName": "doctest",
                "Duration": 12,
                "SQL": "{\"op\": \"insert\",\"ns\": \"doctest.sensor_data\",\"command\": {***}",
                "StartTime": "2025-06-13T10:55:00.254",
                "UserName": "doctest@admin"
            },
            {
                "ClientIP": "100.67.***.***",
                "DBName": "doctest",
                "Duration": 30,
                "SQL": "{\"op\": \"insert\",\"ns\": \"doctest.sensor_data\",\"command\": {***}",
                "StartTime": "2025-06-13T10:54:56.166",
                "UserName": "doctest@admin"
            },
            {
                "ClientIP": "100.67.***.***",
                "DBName": "doctest",
                "Duration": 19,
                "SQL": "{\"op\": \"insert\",\"ns\": \"doctest.sensor_data\",\"command\": {***}",
                "StartTime": "2025-06-13T10:54:56.131",
                "UserName": "doctest@admin"
            },
            {
                "ClientIP": "100.67.***.***",
                "DBName": "doctest",
                "Duration": 38,
                "SQL": "{\"op\": \"insert\",\"ns\": \"doctest.sensor_data\",\"command\": {***}",
                "StartTime": "2025-06-13T10:54:54.068",
                "UserName": "doctest@admin"
            },
            {
                "ClientIP": "100.67.***.***",
                "DBName": "doctest",
                "Duration": 13,
                "SQL": "{\"op\": \"insert\",\"ns\": \"doctest.sensor_data\",\"command\":{***}",
                "StartTime": "2025-06-13T10:54:54.006",
                "UserName": "doctest@admin"
            },
            {
                "ClientIP": "100.67.***.***",
                "DBName": "doctest",
                "Duration": 12,
                "SQL": "{\"op\": \"insert\",\"ns\": \"doctest.sensor_data\",\"command\": {***}",
                "StartTime": "2025-06-13T10:54:53.966",
                "UserName": "doctest@admin"
            },
            {
                "ClientIP": "100.67.***.***",
                "DBName": "doctest",
                "Duration": 15,
                "SQL": "{\"op\": \"insert\",\"ns\": \"doctest.sensor_data\",\"command\": {***}",
                "StartTime": "2025-06-13T10:54:51.961",
                "UserName": "doctest@admin"
            },
            {
                "ClientIP": "100.67.***.***",
                "DBName": "doctest",
                "Duration": 18,
                "SQL": "{\"op\": \"insert\",\"ns\": \"doctest.sensor_data\",\"command\": {***}",
                "StartTime": "2025-06-13T10:54:31.369",
                "UserName": "doctest@admin"
            },
            {
                "ClientIP": "100.67.***.***",
                "DBName": "doctest",
                "Duration": 15,
                "SQL": "{\"op\": \"insert\",\"ns\": \"doctest.sensor_data\",\"command\": {***}",
                "StartTime": "2025-06-13T10:54:31.312",
                "UserName": "doctest@admin"
            },
            {
                "ClientIP": "100.67.***.***",
                "DBName": "doctest",
                "Duration": 14,
                "SQL": "{\"op\": \"insert\",\"ns\": \"doctest.sensor_data\",\"command\": {***}",
                "StartTime": "2025-06-13T10:54:26.161",
                "UserName": "doctest@admin"
            }
        ],
        "ListOver": false,
        "Total": 10
    }
}

请求示例 2

已通过 DescribeSlowLogs 接口查询了慢日志详情，但查询结果并未全部加载（即接口返回结果中的 ListOver 为 false），您可以通过前一次返回结果中的分页标志符（即返回结果中的 Context 值，本文示例中该值为 0,1749812066000,30877190347,2503067），再次调用该接口查询剩余的日志详情，每页记录数为 10。

POST https://mongodb.cn-beijing.volcengineapi.com/?Action=DescribeSlowLogs&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****-1",
    "DBName": "doctest",
    "Context": "0,1749812066000,30877190347,2503067",
    "QueryStartTime": "2025-06-12T11:34:30Z",
    "QueryEndTime": "2025-06-13T10:55:30Z",
    "Sort": "DESC"
}

返回示例 2

{
    "ResponseMetadata": {
        "RequestId": "20230604110420100232280022D31****",
        "Action": "DescribeSlowLogs",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": {
        "Context": "0,1749812055000,30877189357,2503067",
        "Datas": [
            {
                "ClientIP": "100.67.***.***",
                "DBName": "doctest",
                "Duration": 19,
                "SQL": "{\"op\": \"insert\",\"ns\": \"doctest.sensor_data\",\"command\": {****}",
                "StartTime": "2025-06-13T10:54:23.166",
                "UserName": "doctest@admin"
            },
            {
                "ClientIP": "100.67.***.***",
                "DBName": "doctest",
                "Duration": 22,
                "SQL": "{\"op\": \"insert\",\"ns\": \"doctest.sensor_data\",\"command\": {****}",
                "StartTime": "2025-06-13T10:54:23.115",
                "UserName": "doctest@admin"
            },
            {
                "ClientIP": "100.67.***.***",
                "DBName": "doctest",
                "Duration": 17,
                "SQL": "{\"op\": \"insert\",\"ns\": \"doctest.sensor_data\",\"command\": {****}",
                "StartTime": "2025-06-13T10:54:19.991",
                "UserName": "doctest@admin"
            },
            {
                "ClientIP": "100.67.***.***",
                "DBName": "doctest",
                "Duration": 19,
                "SQL": "{\"op\": \"insert\",\"ns\": \"doctest.sensor_data\",\"command\": {****}",
                "StartTime": "2025-06-13T10:54:18.940",
                "UserName": "doctest@admin"
            },
            {
                "ClientIP": "100.67.***.***",
                "DBName": "doctest",
                "Duration": 10,
                "SQL": "{\"op\": \"insert\",\"ns\": \"doctest.sensor_data\",\"command\": {****}",
                "StartTime": "2025-06-13T10:54:17.874",
                "UserName": "doctest@admin"
            },
            {
                "ClientIP": "100.67.***.***",
                "DBName": "doctest",
                "Duration": 11,
                "SQL": "{\"op\": \"insert\",\"ns\": \"doctest.sensor_data\",\"command\": {****}",
                "StartTime": "2025-06-13T10:54:16.812",
                "UserName": "doctest@admin"
            },
            {
                "ClientIP": "100.67.***.***",
                "DBName": "doctest",
                "Duration": 13,
                "SQL": "{\"op\": \"insert\",\"ns\": \"doctest.sensor_data\",\"command\": {****}",
                "StartTime": "2025-06-13T10:54:16.774",
                "UserName": "doctest@admin"
            },
            {
                "ClientIP": "100.67.***.***",
                "DBName": "doctest",
                "Duration": 43,
                "SQL": "{\"op\": \"insert\",\"ns\": \"doctest.sensor_data\",\"command\": {****}",
                "StartTime": "2025-06-13T10:54:16.268",
                "UserName": "doctest@admin"
            },
            {
                "ClientIP": "100.67.***.***",
                "DBName": "doctest",
                "Duration": 11,
                "SQL": "{\"op\": \"insert\",\"ns\": \"doctest.sensor_data\",\"command\": {****}",
                "StartTime": "2025-06-13T10:54:15.800",
                "UserName": "doctest@admin"
            },
            {
                "ClientIP": "100.67.***.***",
                "DBName": "doctest",
                "Duration": 20,
                "SQL": "{\"op\": \"insert\",\"ns\": \"doctest.sensor_data\",\"command\": {****}",
                "StartTime": "2025-06-13T10:54:15.267",
                "UserName": "doctest@admin"
            }
        ],
        "ListOver": false,
        "Total": 10
    }
}

错误码

更多详情，请参见错误码。