POST公开接口

上报日志

客户端上报日志用于排障。服务端会额外记录调用方 IP、User-Agent、由 UA 推断的平台与解析出的地区。短时间内(默认 60 秒,可用 VERHUB_DEDUP_WINDOW_SECONDS 调整)同一调用方上报完全相同的日志会被判为重复上报,直接返回已存在的那条记录而不新建——崩溃重试循环因此不会淹没列表。

URL

/api/v1/public/{projectKey}/logs

鉴权方式

无需鉴权

请求参数

Path 参数

名称类型必填说明
projectKeystring项目主键 project_key(大小写不敏感)

Header 参数

名称类型必填说明
x-verhub-platformwindows | linux | macos | ios | android | web | others客户端平台声明,仅用于请求统计,不影响接口返回内容。 识别优先级:本请求头 > query 参数 `platform` > 请求体 `platform` 字段 > User-Agent 推断。 取值大小写不敏感,无法识别时统计为 OTHERS。 具体系统版本请用 `x-verhub-platform-version` 单独提交;若把版本混在本字段里 (如 `Windows 11`、`ubuntu 24.04`),服务端会拆开,平台与版本分别入库。 建议 SDK 显式声明本请求头:服务端调用的 User-Agent 往往不可靠。
x-verhub-platform-versionstring客户端系统版本明细,仅用于请求统计,不影响接口返回内容。 自由文本,如 `11`、`ubuntu 24.04`、`26`;超过 32 字符视为无效直接丢弃。 识别优先级:本请求头 > query 参数 `platform_version` > 请求体 `platform_version` 字段 > 从 `platform` 中拆出的版本 > User-Agent 推断。

请求体

{
  "level": 2,
  "content": "更新检查请求超时,已重试。",
  "device_info": {
    "os": "Windows 11",
    "arch": "x64"
  },
  "custom_data": {
    "app_version": "1.2.0"
  }
}

响应示例

201 响应

{
  "id": "log-001",
  "level": 2,
  "content": "更新检查请求超时,已重试。",
  "device_info": {
    "os": "Windows 11",
    "arch": "x64"
  },
  "custom_data": {
    "app_version": "1.2.0"
  },
  "is_hidden": false,
  "ip": "203.0.113.9",
  "user_agent": "verhub-sdk/1.0",
  "country_code": "CN",
  "country_name": "中国",
  "region_name": "广东省",
  "city": "深圳",
  "platform": "windows",
  "created_at": 1760000000
}
POST

Try It Out

请求 URL 预览

/api/v1/public/verhub/logs