全部文档

API 与 OTLP

Diting 提供 OTLP 入口、OpenAPI 查询接口和事件通道。已有 OpenTelemetry 链路的团队可以先接 OTLP,再逐步接入 agent。

OTLP

  • gRPC:4317
  • HTTP:4318

发送端需要携带平台签发的令牌。数据进入 gateway 后走与 agent 相同的链路。

OpenAPI

查询接口位于 /api/diting-core/ 下,使用 Bearer 令牌鉴权。响应统一为:

{ "code": 0, "message": "ok", "data": {} }

常见的查询入口包括主机、服务、链路、日志、告警和审计。

示例

查询最近一段时间的主机列表:

curl -s \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"page":1,"pageSize":20}' \
  https://<host>/api/diting-core/hosts/query

具体字段以接口文档为准。字段缺失时接口会返回错误,不会静默返回空数组。

事件通道

实时数据通过 WebSocket 推送。连接需要令牌,断线后客户端负责重连。

令牌

  • 令牌按 scope 授权
  • 建议为集成单独创建令牌
  • 令牌泄露时立即吊销

相关文档:数据模型与信号、权限、审计与多租户。