DescribeSlowLogs--文档数据库 MongoDB 版-火山引擎

文档中心

立即注册

导航

DescribeSlowLogs

最近更新时间：2024.08.15 20:30:46首次发布时间：2024.04.26 11:07:55

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

请求类型

同步请求。

注意事项

当前仅支持查看最近 7 天内的慢日志详情。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mongo-replica-46cb08bc****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息，包括实例 ID。
Limit	Long	是	10	每页记录数，取值范围为 1~1000。
PodName	String	是	mongo-replica-46cb08bc****-1	需要查询慢日志信息的节点 ID。说明您可以调用 DescribeDBInstanceDetail 接口获取指定实例的详细信息，包括实例中各节点的节点 ID 。其中：副本集实例中的 `NodeId` 即为 `PodName`。分片集实例中： `ConfigServersId` 即为 ConfigServer 节点的 `PodName`。 `MongosNodeId` 即为 Mongos 节点的 `PodName` `NodeId` 即为 Shard 节点的 `PodName`。
Sort	String	否	ASC	将查询结果按照日志生成时间升序或降序排列。取值范围如下： `DESC`（默认）：降序排列。 `ASC`：升序排列。
Context	String	否	[1712731868000000,3559571755,2097165,null]	慢日志记录查询结果的上下文，需要加载更多慢日志记录时使用。说明调用 DescribeSlowLogs 接口后，您可以根据返回参数 `ListOver` 的值来确定是否还有未加载的慢日志记录：若 `ListOver` 的值为 `false`，表示还有符合查询条件的慢日志记录未加载完，您可以再次调用 DescribeSlowLogs 接口，并使用上一次接口调用时返回参数中的 `Context` 值来查看剩余的慢日志记录。若 `ListOver` 的值为 `true`，表示已加载完全部符合查询条件的慢日志记录。
DBName	String	否	testdb	慢日志所在的数据库。
Keys	String	否	warning error	检索关键词，用于检索包含关键词的慢日志。说明若不传任何关键词，表示不用关键词对慢日志查询结果进行筛选。支持同时传入多个关键词进行检索，多个关键词间用空格分隔，关键间为或关系。例如，设置检索关键字 `"Keys":"warning error"`，表示检索包含了关键词 `warning` 或 `error` 的日志。日志检索语句最长支持 4 KiB，检索语句中除了 `Keys` 传参部分还有一些系统预设字段，同时为提高检索效率和精度，建议不要传入过多关键词。不支持传入预留关键词进行检索。关于预留关键词的更多信息，请参见日志检索预留关键词。
QueryStartTime	String	否	2024-06-25T07:30:00Z	查询开始时间，格式为 `yyyy-MM-ddTHH:mmZ`（UTC）。说明若该参数留空，实际查询开始时间默认为当前时间 1 小时前的时间（UTC）。例如，当前时间为 2024 年 06 月 25 号 08:30:00（UTC），若 `QueryStartTime` 不填，那么实际查询开始时间为 `2024-06-25T07:30:00Z`。
QueryEndTime	String	否	2024-06-25T08:30:00Z	查询结束时间，格式为 `yyyy-MM-ddTHH:mmZ`（UTC）。说明若该参数留空，实际查询结束时间默认为当前时间（UTC）。查询结束时间需晚于查询开始时间。

返回参数

参数	类型	示例值	描述
Total	Integer	1	查询结果总条目数。
Datas	Object[]		符合查询条件的慢日志列表详情。
Context	String	[1712731868000000,3559571755,2097165,null]	慢日志记录查询结果的上下文，需要加载更多慢日志记录时使用。
ListOver	Boolean	true	慢日志日志内容是否已全部加载。取值范围如下： `true`：已全部加载。 `false`：未全部加载。说明若 `ListOver` 返回 `false`，您可以再次调用 DescribeSlowLogs，并在请求参数中传入 `Context` 返回的值，来查询未加载完的慢日志详情。

示例

请求示例

POST https://mongodb.volcengineapi.com/?Action=DescribeSlowLogs&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": 10,
    "StartTime": 1712728800,
    "EndTime": 1712728860,
    "Sort": "ASC",
    "InstanceId": "mongo-replica-e405f8e2****",
    "PodName": "mongo-replica-e405f8e2****-1",
    "Context": "[1712731868000000,3559571755,2097165,null]"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420010010023228002****",
        "Action": "DescribeSlowLogs",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": {
        "Total": 1,
        "Datas": [
            {
                "DBName": "test528683",
                "UserName": "root@admin",
                "SQL": "{ \t\"op\": \"select\", \t\"ns\": \"test528683.test528683\", \t\"command\": { **** \t}, \t\"user\": \"root@admin\" }",
                "StartTime": "2024-04-10T14:00:03.875",
                "Duration": 108,
                "ClientIP": "127.0.***.***",
                "FileScan": 10,
                "Return": 2,
                "IndexScan": 5
            }
        ],
        "Context": "[1712731868000000,3559571755,2097165,null]",
        "ListOver": true
    }
}

错误码

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