菜单路径: 仪表板 > 日志

日志

概述

日志是您可以在一处查看某个端点所有 API 调用记录的页面。您可以查看请求的成功/失败、发送的 Payload、Webhook 投递状态以及错误信息。

沙盒环境和生产环境分别位于不同的标签页中,因此您可以独立追踪测试调用和正式运营调用。

如何进入

  • 顶部菜单 日志 → 从列表中选择一个端点
  • 端点详情右侧边栏中的 查看日志 链接

端点列表

日志端点列表

首次打开日志页面时,您会看到端点列表。它按端点汇总了日志状态。

说明
端点 端点名称
总日志数 此端点的总调用次数
成功率 成功调用所占的百分比
最近活动 最近一次调用时间(相对时间)

点击某个端点即可进入其详细日志页面

详细页面顶部

详细页面顶部

选择某个端点后,页面顶部会显示以下元素。

  • 端点名称和说明
  • 查看 API 详情 按钮 — 前往端点详情页面
  • 清除沙盒数据 按钮 — 永久删除此端点的沙盒调用记录和使用统计
    • 协作者访问时显示为 清除我的沙盒数据,仅删除该协作者生成的记录
    • 不会影响生产环境数据
  • 沙盒环境 | 生产环境 环境标签页 — 独立查看各环境的日志(详细了解环境标签页

搜索筛选

搜索区域包含两个标签页:时间段搜索字段搜索

时间段搜索

时间段搜索筛选

按时间范围和状态筛选日志。

  • 日期字段 — 选择 处理时间创建时间。默认为处理时间
  • 开始日期 / 结束日期 — 指定时间范围
  • 状态 — 可选择 全部 / 成功 / 失败
  • 协作密钥全部 或特定的协作密钥(仅显示使用该密钥发起的调用)

字段搜索

字段搜索筛选

当您希望按特定值查找日志时使用。

  • 字段 选择:
    • 请求 ID — 按记录 ID 精确匹配
    • 内容搜索 — 在端点的可搜索字段中搜索值(例如 order_idcustomer_email,至少 3 个字符)
  • 输入 搜索值 并执行
  • 选择 内容搜索 时会出现 开始日期 / 结束日期 输入框。若未指定日期,默认在最近一个月内搜索

日志列表

日志列表

搜索筛选下方以表格形式显示该端点的调用历史。

说明
请求 ID 记录标识符
状态 成功 · 失败 · 处理中 徽章
协作密钥 本次调用使用的协作密钥(未指定则为默认)
创建时间 API 调用接收时间
处理时间 存储和 Webhook 处理完成时间

点击任意行即可进入日志详情页面


日志详情页面

概览

日志概览

显示单次调用的详细信息。

  • 请求 ID:记录的唯一标识符
  • 端点:接收此次调用的端点
  • 版本:调用时的配置版本
  • 处理时间:存储和 Webhook 处理完成时间
  • 响应时间:网关处理时间(毫秒)
  • 协作密钥:所使用协作密钥的名称和描述(如适用)
  • 错误信息 / 错误详情:对于失败的调用,显示错误类型、状态码、字段错误和发生时间
  • 查看端点 按钮 — 前往此端点的详情页面

Payload

Payload 区块

显示随 API 调用发送的原始 JSON 数据

在生产环境中,超过 30 天的 Payload 会被自动归档,不会直接显示在列表中。此时请点击 加载归档 Payload 按钮以获取已归档的 Payload。

Danger Zone

Danger Zone

  • 删除日志记录 — 永久删除此日志记录
  • 记录本体及其关联的 Payload 会被一并删除。此操作不可撤销
  • 不会影响使用统计

查看端点快速链接

详细页面右侧显示一张快速链接卡片,用于跳转到当前日志对应的端点详情页面。您可以快速确认端点的设置、Webhook、协作密钥等。


常见问题

  • 日志为空:在生产部署之前,生产环境标签页不会显示任何记录。请先在沙盒环境标签页确认测试调用是否已被记录
  • 搜索无结果内容搜索 要求端点已定义可搜索字段(Searchable)。请在端点详情 > 必填字段中确认 Searchable 是否已设置
  • 看不到 Payload:在生产环境中,超过 30 天的调用的 Payload 会被归档。请使用 加载归档 Payload 按钮获取
  • 想仅查看某位协作者的调用:在时间段搜索标签页的 协作密钥 下拉菜单中选择该协作密钥
  • 沙盒清除可以撤销吗?:不可以。被清除的沙盒调用记录和统计会被永久删除,请谨慎使用