云数据库 MongoDB 日志查询接口

1. 接口描述

接口请求域名： mongodb.tencentcloudapi.com 。

该接口（DescribeMongodbLogs）用于查询运行日志。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeMongodbLogs。
Version	是	String	公共参数，本接口取值：2019-07-25。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例 ID。请登录 MongoDB 控制台在实例列表复制实例 ID。示例值：cmgo-k2p5su09
StartTime	是	String	查询日志的开启时间。 - 格式：yyyy-mm-dd hh:mm:ss，如：2019-06-01 10:00:00。 - 查询时间范围：仅支持查询最近 7 天内的日志数据。示例值：2020-04-20 00:00:00
EndTime	是	String	查询日志的结束时间。 - 格式：yyyy-mm-dd hh:mm:ss，如：2019-06-01 10:00:00。 - 查询时间范围：仅支持查询最近 7 天内的日志数据。示例值：2020-04-20 00:00:00
NodeNames.N	否	Array of String	节点 ID。请登录 MongoDB 控制台的节点管理页面获取查询的节点 ID。示例值：["cmgo-xxx_0-node-primary"]
LogComponents.N	否	Array of String	日志类别。 - 日志类别包括但不限于 COMMAND、ACCESS、CONTROL、FTDC、INDEX、NETWORK、QUERY、REPL、SHARDING、STORAGE、RECOVERY、JOURNAL 和 WRITE 等。具体支持的类别可能会因 MongoDB 的版本而存在差异。具体信息，请参见日志消息。 - 登录 MongoDB 控制台，在日志管理页面的错误日志页签，也可查看日志类别。示例值：["COMMAND"]
LogLevels.N	否	Array of String	日志级别。 - 日志级别按严重性从高到低依次为：FATAL、ERROR、WARNING。 - 登录 MongoDB 控制台，在日志管理页面的错误日志页签，可查看日志级别。示例值：["WARNING"]
LogIds.N	否	Array of String	日志 ID。登录 MongoDB 控制台，在日志管理页面的错误日志页签，可查看日志 ID。示例值：["1245"]
LogConnections.N	否	Array of String	日志连接信息。登录 MongoDB 控制台，在日志管理页面的错误日志页签，可查看日志连接信息。示例值：["conn268164"]
LogDetailParams.N	否	Array of String	指定日志筛选的字段。示例值：["*"]
Offset	否	Integer	偏移量，最小值为0，最大值为10000，默认值为0。示例值：0
Limit	否	Integer	分页大小，最小值为1，最大值为100，默认值为20。示例值：100

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	日志总数。示例值：1000
LogList	Array of LogInfo	日志详情列表。注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询日志

本接口用于查询实例日志

输入示例

POST / HTTP/1.1
Host: mongodb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMongodbLogs
<公共请求参数>

{
    "InstanceId": "cmgo-k2p5su09",
    "StartTime": "2024-03-07 9:22:15",
    "EndTime": "2024-03-07 15:33:15",
    "LogComponents": [
        "NETWORK"
    ],
    "LogConnections": [],
    "LogIds": [],
    "LogDetailParams": [
        "client metadata"
    ]
}

输出示例

{
    "Response": {
        "LogList": [
            {
                "LogComponent": "NETWORK",
                "LogConnection": "conn269939",
                "LogDetail": "{\"t\":{\"$date\":\"2024-03-07T10:29:50.027+08:00\"},\"s\":\"I\",  \"c\":\"NETWORK\",  \"id\":51800,   \"ctx\":\"conn269939\",\"msg\":\"client metadata\",\"attr\":{\"remote\":\"127.0.0.1:39024\",\"client\":\"conn269939\",\"doc\":{\"driver\":{\"name\":\"mongo-go-driver\",\"version\":\"v1.10.6\"},\"os\":{\"type\":\"linux\",\"architecture\":\"amd64\"},\"platform\":\"go1.20.4\",\"application\":{\"name\":\"CMongo\"}}}}",
                "LogId": "51800",
                "LogLevel": "WARNING",
                "LogTime": "2024-03-07T10:29:50.027+08:00"
            }
        ],
        "RequestId": "ab2323tf-rqew1111",
        "TotalCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError	内部错误。
InvalidParameterValue.NotFoundInstance	未找到实例。
InvalidParameterValue.TimeFormatErr	非法的时间格式。

日志查询接口

本页目录：