跳转到主要内容
POST
丰富错误栈信息

限制说明

使用说明

  • 省略 type 时默认按 browser 处理。
  • service、version 须与上传时一致;找不到对应符号的栈帧会以 converted: false 返回。
  • 设置 1 到 20 之间的 near 可在转换后的栈帧附近返回源码片段。
  • source_type(错误事件的 error.source_type)会改变路由:type: android 时,值中含 ndk,或值为空但传了 arch,按 NDK native 符号处理;type 为 flutter 或 react-native 时,ios 走 dSYM,android/ndk 走 Android 符号;type: electron 时,macos/windows/linux 按 Breakpad 符号解析 minidump 栈帧。
  • iOS 崩溃栈需传入 binary_images,以便按上传的 dSYM 文件重定位地址。
  • 结果按错误栈缓存;no_cache: true 会绕过缓存,主要用于调试。

授权

app_key
string
query
必填

在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集,请妥善保管。

请求体

application/json

错误栈 enrich 请求。

service
string
必填

上传 Sourcemap 时使用的应用或服务名称。

version
string
必填

上传 Sourcemap 时使用的应用版本。

arch
string

native CPU 架构,如 arm、arm64、x86、x64。type: android 且 source_type 为空时,传入 arch 即按 NDK native 符号化。

binary_images
object[]

iOS 崩溃报告中的已加载 binary image 列表。

build_id
string

Gradle 插件 1.13.0 及以后版本使用的 Android build ID。

near
integer

在转换后的栈帧附近返回的有效源码行数。

必填范围: 1 <= x <= 20
no_cache
boolean

跳过缓存的 enrich 结果,主要用于调试。

platform
enum<string>

将 react-native 的 enrich 限定到应用的 native 平台:ios 表示 iOS native 层,android 表示 Android native 层(控制台根据事件的 OS 推导)。其他 type 取值下忽略。

可用选项:
ios,
android
source_type
string

SDK 上报的错误 error.source_type,会改变符号化路由:android 下值中含 ndk 时使用 NDK native 符号;flutter 与 react-native 下 ios 使用 dSYM、android/ndk 使用 Android 符号;electron 下 macos、windows、linux 使用 Breakpad 符号。其他类型忽略此字段。

stack
string

待解析和 enrich 的原始错误栈。

type
enum<string>

错误来源平台,决定使用哪类符号存储。省略时默认按 browser 处理。

可用选项:
browser,
android,
ios,
miniprogram,
harmony,
flutter,
electron,
react-native
variant
string

旧版 Gradle 插件使用的 Android build variant。

响应

成功

成功响应结构。2xx 响应中 request_id 标识本次调用(同时出现在 Flashcat-Request-Id 响应头中),data 为接口业务 payload。失败响应使用不同结构,参见 ErrorResponse。

request_id
string
必填

本次请求的唯一 ID,也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

enrich 后的错误栈帧。