跳转到主要内容
GET
curl

概览

返回每项 Didit 服务的状态、整体状态,以及当前进行中的事件和过去 7 天内已解决的事件。 该端点为公开端点,请勿发送认证请求头。 响应不包含任何组织数据,对所有调用方都相同。

适用场景

  • 状态组件:向您的用户或支持团队展示某项 Didit 服务当前是否处于降级状态。
  • 集成健康检查:在怀疑是您自己的代码导致检查缓慢或失败之前,先查看 Didit 是否报告了您所调用服务的事件。
  • 事件历史:列出过去 7 天内发生的事件,以及每起事件持续的时长。
如果只想确认 API 是否可以访问,请改用健康检查。

轮询

响应缓存 30 秒,因此轮询频率不要超过每 30 秒一次。 updated_at 表示 Didit 生成您所收到响应的时间。 同时适用 GET 速率限制:每个 IP 地址每分钟 600 次请求。

服务

services 列出所有服务,无论其是否有事件。 请按 key 匹配:name 是英文显示名称,可能会更改。 每项服务的 status 为 operational、degraded 或 down。 当服务没有进行中的事件时为 operational,否则为其进行中事件中最严重的状态。 顶层 status 为所有服务中最严重的状态。

事件

incidents 列出所有进行中的事件,以及过去 7 天内已解决的事件,按 started_at 从新到旧排列。 最多列出 50 个已解决的事件。
  • state 为 degraded 或 down。已解决的事件保留其最后的状态。
  • status 在服务恢复之前为 ongoing,恢复后变为 resolved。
  • 事件进行中时,resolved_at 和 duration_minutes 为 null。
  • affected 和 country_name 说明受影响的国家或登记库,例如 Brazil (CPF) 和 Brazil。事件与某个国家或登记库无关时,这两个字段为空。
  • title 和 body 为英文。若要以其他语言展示事件,请根据 service、state 和 country_name 自行生成文本。

响应示例

相关内容

  • 健康检查:公开的存活探测端点,同样无需认证请求头。
  • 警报 Webhook:针对您组织使用的服务,将 alert.service.degraded 和 alert.service.recovered 推送到您的端点。
  • 速率限制

响应

当前服务状态。

公开服务状态:各项 Didit 服务的状态、整体状态以及正在发生或在过去 7 天内已解决的事件。

status
enum<string>
必填

所有服务当前状态中的最差状态,仅由正在发生的事件决定。

可用选项:
operational,
degraded,
down
示例:

"degraded"

updated_at
string<date-time>
必填

Didit 生成此响应的时间(ISO 8601,UTC)。响应会缓存 30 秒,因此可能最多有 30 秒的延迟。

示例:

"2026-10-13T09:41:07.512345Z"

services
object[]
必填

每个服务对应一个条目,始终列出所有服务。

incidents
object[]
必填

按 started_at 最新的优先排序。包括所有进行中的事件,加上过去 7 天内解决的事件(最多 50 个已解决事件)。若在此期间无事件发生则为空。

最后修改于 2026年11月7日