有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

本接口(DescribeSlowLogs)用于获取云数据库实例的慢查询日志。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeSlowLog。
Version String 公共参数,本接口取值:2018-04-08。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
示例值:cmgo-eqmoa5sf
StartTime Timestamp 慢日志起始时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
示例值:2019-06-04 20:21:00
EndTime Timestamp 慢日志终止时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
示例值:2019-06-04 20:22:00
SlowMS Integer 慢日志执行时间阈值,返回执行时间超过该阈值的慢日志,单位为毫秒(ms),最小为100毫秒。
示例值:200
Offset Integer 偏移量,最小值为0,最大值为10000,默认值为0。
示例值:20
Limit Integer 分页大小,最小值为1,最大值为100,默认值为20。
示例值:20

3. 输出参数

参数名称 类型 描述
TotalCount Integer 符合查询条件的慢查询日志总数。
示例值:1
SlowLogList Array of String 符合查询条件的慢查询日志详情。
示例值:["Tue Jun 4 17:52:39.247 I COMMAND [conn2898] xxxx"]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询云数据库MongoDB实例慢日志

客户需要通过API查询云数据库MongoDB实例慢日志

输入示例

https://mongodb.tencentcloudapi.com/?Action=DescribeSlowLog
&InstanceId=cmgo-eqmoa5sf
&StartTime=2019-06-04 20:21:00
&EndTime=2019-06-04 20:22:00
&SlowMS=200
&Offset=20
&Limit=20
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 1,
        "RequestId": "302530d2-ee57-495e-89d0-51e03b11815e",
        "SlowLogList": [
            "Tue Jun  4 17:52:39.247 I COMMAND  [conn2898] xxxx"
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameter 参数错误。
InvalidParameter.PermissionDenied 当前子账号无权执行该操作。
InvalidParameterValue.LimitParaOutOfRange limit取值范围[1,100]。
InvalidParameterValue.NotFoundInstance 未找到实例。
InvalidParameterValue.OffsetParaOutOfRange offset取值范围[0, 10000]。
InvalidParameterValue.QueryTimeOutOfRange 只能查询7天内的慢日志。
InvalidParameterValue.QueryTimeRangeBeyondLimit 只能查询7天内的慢日志。
InvalidParameterValue.SlowMSBelowLimit slowMS参数取值范围[100, 。
InvalidParameterValue.StartTimeNotBeforeThanEndTime 起始时间晚于结束时间。
InvalidParameterValue.TimeFormatErr 非法的时间格式。