跳转到主要内容
POST
创建事件时间线

限制说明

使用说明

  • at_seconds 不能早于事件最新一条时间线更新的时间。
  • 与组件当前状态相同的组件变更会被丢弃,不写入该条更新。
  • 切换为 resolved 或 completed 时,所有受影响组件都必须为 operational;对已结束的事件发布非终态状态会重新打开该事件。
  • 事件描述会被更新为本条更新的描述。若事件开启了 notify_subscribers,会就本条更新通知订阅者。
  • 手动将自动更新的维护事件切换为 ongoing 或 completed,会取消对应的定时切换。
  • 传入 draft_id 可发布 change_id 指向本事件的草稿;草稿只能发布一次。
  • 每次调用都会记录到账户审计日志,请勿在请求字段中写入敏感信息。

授权

app_key
string
query
必填

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

请求体

application/json

向状态页事件时间线追加一条更新所需的参数。

page_id
integer<int64>
必填

状态页 ID,可通过 GET /status-page/list 获取。

change_id
integer<int64>
必填

目标事件 ID,可通过 GET /status-page/change/list 获取。

status
enum<string>
必填

本次更新后的事件状态,必须与事件类型匹配。若不改变状态,请传入当前状态。切换为 resolved 或 completed 时,所有受影响组件必须已恢复为 operational。

可用选项:
investigating,
identified,
monitoring,
resolved,
scheduled,
ongoing,
completed
description
string
必填

更新说明(支持 Markdown),必填,不能为空。

at_seconds
integer<int64>

更新时间,Unix 时间戳(秒),不能早于事件最新一条时间线更新。省略或为 0 时取当前时间。

component_changes
object[]

本次更新应用的组件状态变更。组件 ID 不能重复。

draft_id
string

待发布草稿的 ID(由 POST /status-page/draft/create 返回,且其 change_id 指向本事件);更新写入后草稿标记为已发布。不发布草稿时省略。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

向状态页事件追加时间线更新的结果。