小程序
取消
开发
中文
EN
取消
  • 指南

    • # 查询实时日志

    调试诊断

    接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南

    接口英文名：realtimelogSearch

    该接口用于查询实时日志。

    # 1. 调用方式

    # HTTPS 调用

    GET https://api.weixin.qq.com/wxaapi/userlog/userlog_search?access_token=ACCESS_TOKEN

    # 云调用

    • 本接口不支持云调用

    # 第三方调用

    • 本接口支持第三方平台代商家调用。

    • 该接口所属的权限集 id 为：18

    • 服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看 第三方调用 说明文档。

    # 2. 请求参数

    # 查询参数 Query String parameters

    参数名类型必填说明
    access_tokenstring是接口调用凭证，可使用 access_token、authorizer_access_token

    # 请求体 Request Payload

    参数名类型必填说明
    datestring是YYYYMMDD格式的日期，仅支持最近7天
    begintimenumber是开始时间，必须是 date 指定日期的时间
    endtimenumber是结束时间，必须是 date 指定日期的时间
    startnumber否开始返回的数据下标，用作分页，默认为0
    limitnumber否返回的数据条数，用作分页，默认为20
    traceIdstring否小程序启动的唯一ID，按 TraceId 查询会展示该次小程序启动过程的所有页面的日志。
    urlstring否小程序页面路径，例如pages/index/index
    idstring否用户微信号或者OpenId
    filterMsgstring否开发者通过setFileterMsg/addFilterMsg指定的 filterMsg 字段
    levelnumber否日志等级，返回大于等于 level 等级的日志，level的定义为2（Info）、4（Warn）、8（Error），如果指定为4，则返回大于等于4的日志，即返回 Warn 和Error日志

    # 3. 返回参数

    # 返回体 Response Payload

    参数名类型说明
    errcodenumber错误码
    errmsgstring错误信息
    dataobject返回的日志数据和日志条数总量

    # Res.data Object Payload

    返回的日志数据和日志条数总量

    参数名类型说明
    listobjarray返回的日志数据列表
    totalnumber日志条数总量

    # Res.data.list(Array) Object Payload

    返回的日志数据列表

    参数名类型说明
    levelnumber日志等级，是 msg 数组里面的所有 level 字段的或操作得到的结果。例如 msg 数组里有两条日志，Info（值为2）和Warn（值为4），则 level 值为6
    libraryVersionstring基础库版本
    clientVersionstring客户端版本
    idstring微信用户OpenID
    timestampnumber打日志的 Unix 时间戳
    platformnumber1 安卓 2 IOS
    urlstring小程序页面链接
    msgobjarray日志内容数组，log.info等的内容存在这里
    traceidstring小程序启动的唯一ID，按 TraceId 查询会展示该次小程序启动过程的所有页面的日志
    filterMsgstringfilterMsg

    # Res.data.list(Array).msgObject Payload

    日志内容数组，log.info等的内容存在这里

    参数名类型说明
    timenumberlog.info调用的时间
    msgarraylog.info调用的内容，每个参数分别是数组的一项
    levelnumberlog.info调用的日志等级

    # 4. 注意事项

    本接口无特殊注意事项

    # 5. 代码示例

    请求示例

    {
        "date": '',
        "begintime": '',
        "endtime": '',
        "start": '',
        "limit": '',
        "traceId": '',
        "url": '',
        "id": '',
        "filter_msg": '',
        "filterMsg": ''
      }
      ```

返回示例

```json
{
  "errcode": 0,
  "errmsg": "",
  "data": {
    "list": [
      {
        "level": 6,
        "platform": 1,
        "libraryVersion": "2.8.3",
        "clientVersion": "7.0.7",
        "id": "oXu034-Kl5Et2U0vsexKDsFaon0Q",
        "timestamp": 1570852796,
        "msg": [
          {
            "time": 1570852795,
            "msg": [
              "hello world"
            ],
            "level": 2
          },
          {
            "time": 1570852795,
            "msg": [
              "get msg list mig 10006"
            ],
            "level": 4
          }
        ],
        "url": "pages/chat/chat",
        "traceid": "oXu03410akoNqfsrMMswk6Zwwl1U_1570852656",
        "filterMsg": "NetworkExceed08 ReportTimeTotal"
      }
    ],
    "total": 1000
  }
}

    # 6. 错误码

    以下是本接口的错误码列表，其他错误码可参考 通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具 辅助定位和分析问题。

    错误码错误描述解决方案
    40001invalid credential  access_token isinvalid or not latest获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口
    200002参数错误，date、begintime、endtime必填。date只能是最近三天的日期，endtime必须大于begintime
    200007无权限
    200010操作过于频繁，目前限制每分钟50次

    # 7. 适用范围

    本接口在不同账号类型下的可调用情况：
    小程序小游戏
    ✔ ✔
    • ✔：该账号可调用此接口
    • 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口；