跳到主要内容

API日志

核心概念:基础设施 | API日志 | 概览

API 日志用于追查“谁在什么时间发起了什么操作、系统返回了什么结果”。本页包含三套相互独立的记录:访问日志、错误日志和机顶盒日志。三套记录的查询条件和字段不同,不应混在一起理解。


核心概念:基础设施 | API日志 | 快速访问 (API日志)

快速访问 (API日志)​

在API日志模块中,您可以快速访问日志查询页面。

访问日志入口:打开访问日志

错误日志入口:打开错误日志

机顶盒日志入口:打开机顶盒日志


核心概念:基础设施 | API日志 | 功能说明 (API日志)

功能说明 (API日志)​

API日志模块主要用于:

  • 记录API接口调用详情
  • 监控接口性能和执行时长
  • 追踪接口异常和错误
  • 分析接口使用情况

核心概念:基础设施 | API日志 | 1. 访问日志 (API日志)

1. 访问日志 (API日志)​

访问日志记录管理后台和各业务服务收到的操作请求。它既可能显示成功,也可能显示失败;“访问日志”并不等同于“成功日志”。

查看访问日志​

从系统一级菜单“API日志”进入“访问日志”,可以查看 API 调用记录。截图中的旧菜单层级仅用于识别页面内容,不代表当前入口层级。

访问日志列表

搜索条件 (访问日志)​

在访问日志列表中,支持按以下条件搜索:

  • 用户:选择特定用户
  • 用户类型:选择用户类型
  • 应用名:选择应用名称
  • 请求时间:选择时间范围
  • 执行时长:输入执行时长
  • 结果码:输入结果代码

列表字段说明 (访问日志)​

访问日志列表显示以下信息:

  • 日志编号:日志的唯一标识
  • 用户名称:调用接口的用户账号
  • 用户昵称:用户的昵称
  • 用户类型:用户的类型标识
  • 应用名:处理本次请求的系统服务
  • 请求方法:HTTP请求方法(GET/POST等)
  • 请求地址:API接口的URL路径
  • 请求时间:接口调用的具体时间
  • 执行时长:接口处理耗时(毫秒)
  • 操作结果:调用是否成功
  • 操作模块:所属功能模块
  • 操作名:具体操作名称
  • 操作类型:操作的分类
  • 操作:打开当前访问日志详情

核心概念:基础设施 | API日志 | 查看访问日志详情 (API日志)

查看访问日志详情 (API日志)​

在访问日志模块中,您可以查看单条日志的详细信息。

  1. 在列表中找到要查看的日志记录
  2. 点击"详细"按钮
  3. 查看完整的请求和响应信息

访问日志详情

详情字段说明:

  • 日志主键:日志ID
  • 链路追踪:Trace ID,用于链路追踪
  • 应用名:应用名称
  • 用户信息:用户昵称及类型
  • 用户 IP:客户端IP地址
  • 用户 UA:User Agent信息
  • 请求信息:Method + URL
  • 请求参数:接口请求的具体参数
  • 请求结果:系统返回给调用方的内容
  • 请求时间:开始时间和结束时间
  • 请求耗时:执行时长
  • 操作结果:成功或失败信息
  • 操作模块:所属模块
  • 操作名:操作名称
  • 操作类型:操作分类

核心概念:基础设施 | API日志 | 2. 错误日志 (API日志)

2. 错误日志 (API日志)​

错误日志记录系统处理请求时发生的异常,便于维护人员定位问题。它与访问日志各自保存:同一次操作可能既有访问记录,也产生错误记录。

查看错误日志​

从系统一级菜单进入“API日志”,再选择“错误日志”,可以查看接口错误记录。

错误日志列表

搜索条件 (错误日志)​

在错误日志列表中,支持按以下条件搜索:

  • 用户:选择特定用户
  • 用户类型:选择用户类型
  • 应用名:选择应用名称
  • 异常时间:选择时间范围
  • 处理状态:选择处理状态(未处理/已处理/已忽略)

列表字段说明 (错误日志)​

错误日志列表显示以下信息:

  • 日志编号:日志ID
  • 用户名称:用户账号
  • 用户昵称:用户昵称
  • 用户类型:用户类型
  • 应用名:应用名称
  • 请求方法:HTTP方法
  • 请求地址:接口URL
  • 异常发生时间:异常发生的时间点
  • 异常名:异常类的名称
  • 处理状态:当前日志的处理状态
  • 操作:查看详情;未处理记录还可标记为“已处理”或“已忽略”

核心概念:基础设施 | API日志 | 查看错误日志详情 (API日志)

查看错误日志详情 (API日志)​

在错误日志模块中,您可以查看异常的详细堆栈信息。

  1. 在列表中找到要查看的日志记录
  2. 点击"详细"按钮
  3. 查看完整的异常堆栈信息

错误详细信息

详情字段说明:

  • 日志主键:日志ID
  • 链路追踪:Trace ID
  • 应用名:应用名称
  • 用户编号:用户ID及类型
  • 用户 IP:客户端IP
  • 用户 UA:客户端User Agent
  • 请求信息:Method + URL
  • 请求参数:请求参数内容
  • 异常时间:异常发生时间
  • 异常名:异常类名称
  • 异常堆栈:详细的异常堆栈跟踪信息
  • 处理状态:当前状态
  • 处理人:处理该异常的用户ID
  • 处理时间:处理时间

核心概念:基础设施 | API日志 | 处理错误日志 (API日志)

处理错误日志 (API日志)​

针对未处理的错误日志,您可以进行以下操作:

  • 已处理:标记该异常已经处理修复
  • 已忽略:标记该异常无需处理

核心概念:基础设施 | API日志 | 导出日志 (API日志)

导出日志 (API日志)​

访问日志和错误日志页面支持导出;机顶盒日志当前没有导出按钮。

  1. 在访问日志或错误日志页面设置筛选条件(可选)。
  2. 点击“导出”按钮。
  3. 下载 Excel 文件。

导出会沿用当前页面的筛选条件。机顶盒日志如需提供排查材料,应在授权范围内复制必要内容并去除无关敏感信息,不要把本节的导出说明套用到机顶盒日志。


核心概念:基础设施 | API日志 | 机顶盒日志

3. 机顶盒日志​

机顶盒日志用于查询设备与系统交互时形成的请求记录,数据来自集中保存的设备日志服务。入口为一级菜单“API日志 → 机顶盒日志”。它不是访问日志或错误日志的另一种展示方式。

查询条件(机顶盒日志)​

条件含义与使用方式选项来源
时间范围限定日志产生时间。查询设备问题时,先尽量缩短到问题发生前后手动选择
MAC 地址按设备 MAC 缩小范围手动输入
请求类型按心跳、任务检测、域名分发等业务动作筛选;也允许输入字典中没有的实际类型数据字典 stb_log_type,当前值见下文
排序方向正序从较早记录开始,倒序从较新记录开始页面固定选项,不是数据字典

时间范围是定位日志的基础条件。范围过大时,应先缩短时间,再结合 MAC 或请求类型查询。点击搜索后页面可能需要等待日志服务返回结果,倒计时期间不应反复点击。

机顶盒日志查询结果

列表字段(机顶盒日志)​

字段含义
日志采集时间该条记录进入日志服务的时间,不一定与设备发起请求的时间完全相同
MAC 地址、CPU日志中随请求记录的设备标识;用于辅助定位设备
DeviceToken设备请求携带的身份信息,列表只显示前一部分
请求类型本次请求对应的业务动作;部分类型会换成更易读的显示名称,但查询仍按原始类型匹配
域名本次请求访问的域名
请求时间、响应时间系统记录的请求开始和返回时间
耗时从请求到响应的用时,单位为毫秒
HTTP 状态本次网络请求的返回状态;它只反映请求是否正常返回,业务是否成功还要结合响应体中的结果判断
请求地址、请求方法本次访问的地址和方式
请求参数、响应体设备提交的内容和系统返回内容;列表只适合快速查看,完整内容在详情中查看
客户端 IP发起请求的网络地址
来源日志记录的来源标识
操作打开该条日志的详情抽屉

机顶盒单条日志详情

详情字段(机顶盒日志)​

详情左右两侧分别展示原始内容和便于阅读的整理结果。整理结果只是为了帮助阅读,不会改写原始日志;排查问题时应保留原始内容进行核对。

区域字段或内容数据来源与含义
DeviceToken 解析设备 ID、MAC 地址、CPU ID、型号 ID、设备型号、订单号、SDK 版本、渠道 ID、渠道名称、激活时间、地区 ID、Launcher 包名、真实 DDR、真实 Flash、主控型号、设备创建时间页面根据当前日志中的 DeviceToken 尝试查找设备资料。解析失败或没有匹配设备时,本区域不显示有效数据;这不代表原始日志不存在
原始内容请求参数、响应体日志服务保存的原始内容,可按权限复制
友好格式整理后的请求参数、响应体页面根据请求类型整理显示,便于阅读;仍应以左侧原始内容为核对依据
域名分发解密数据域名分发业务的可读内容仅当该条响应属于支持整理的域名分发数据时显示
底部信息HTTP 状态、响应码、耗时、来源 IP、日志时间、链路 ID对本次请求结果和定位信息的汇总

三类日志中的请求参数、返回内容、DeviceToken、IP、用户信息和解析出的设备资料都可能包含敏感信息。只可在授权范围内查看、导出、复制和转发;向他人提供排查材料时,应先去除与问题无关的身份信息和业务数据。


核心概念:基础设施 | API日志 | 数据字典

数据字典​

以下字典数据截至 2026-08-27 17:48:07(UTC+8),所列字典项当前均为启用状态。

应用名称​

访问日志和错误日志的“应用名”使用字典“应用名称”,字典类型为 app_name。

显示名称/取值
device-server
task-server
launcher-server
blacklist-server
bpm-server
system-server
infra-server
gateway-server
report-server
rule-server

用户类型​

访问日志和错误日志的“用户类型”使用字典“用户类型”,字典类型为 user_type。

显示名称取值
会员1
管理员2

操作类型​

访问日志列表和详情中的“操作类型”使用字典“操作类型”,字典类型为 infra_operate_type。

显示名称取值
其它0
查询1
新增2
修改3
删除4
导出5
导入6

异常处理状态​

错误日志的“处理状态”使用字典“API 异常数据的处理状态”,字典类型为 infra_api_error_log_process_status。

显示名称取值
未处理0
已处理1
已忽略2

机顶盒日志请求类型​

“请求类型”使用字典“机顶盒日志请求类型”,字典类型为 stb_log_type。

显示名称取值
设备心跳设备心跳
入网认证(新)入网认证(新)
UOTA自更新APP检测更新
检测任务推送检测任务推送
黑名单检测黑名单检测
记录设备事件记录设备事件
获取新MAC地址获取新MAC地址
获取launcher广告获取launcher广告
launcher广告播放上报launcher广告播放上报
launcher广告播放上报(V2)德国时区三方广告上报
launcher广告位执行回调launcher广告位执行回调
获取域名和apk-域名分发获取域名和apk-域名分发
入网认证(旧)入网认证(旧)
APP活跃上报(V2)APP活跃上报(V2)
APP活跃上报(V1)APP活跃上报(V1)
文件下载重定向文件下载重定向
设备日志文件上传设备日志文件上传
获取服务器时间-域名分发获取服务器时间-域名分发
三方服务获取设备端通用配置三方服务获取设备端通用配置
OndaTV_156x130重定向异常下载OndaTV_156x130重定向异常下载
WEBSOCKETWEBSOCKET
黑名单回调黑名单回调
检测launcher资源更新检测launcher资源更新
任务回调任务回调
检测更新任务检测更新任务

核心概念:基础设施 | API日志 | 注意事项 (API日志)

注意事项 (API日志)​

  • 日志数据量较大,查询时优先缩短时间范围,避免一次检索过多无关记录。
  • 错误日志标记为“已处理”或“已忽略”只改变处理状态,不会修改已经发生的请求事实。
  • 访问日志中的失败、错误日志中的异常,以及机顶盒日志中的非成功状态含义不同,应在各自页面结合请求时间、地址和返回内容判断。
开发文档
AI 助手
Agent 列表
请选择一个 Agent 开始对话
AI 问答