Skip to main content
POST
创建状态页事件

限制说明

授权

app_key
string
query
必填

在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证,请妥善保管。

请求体

application/json

创建状态页故障或维护事件所需的参数。首条更新必须包含 component_changes 以声明受影响组件;回溯事件至少需要 2 条更新。

page_id
integer<int64>
必填

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

type
enum<string>
必填

事件类型:incident 故障,maintenance 计划维护。

可用选项:
incident,
maintenance
title
string
必填

事件标题,最多 255 个字符。

Maximum string length: 255
description
string
必填

事件描述(支持 Markdown),必填,不能为空。

status
enum<string>
必填

事件初始状态。故障事件支持 investigating/identified/monitoring/resolved;维护事件支持 scheduled/ongoing/completed

可用选项:
investigating,
identified,
monitoring,
resolved,
scheduled,
ongoing,
completed
updates
object[]
必填

时间线更新列表。至少传 1 条,且至少有一条必须包含 component_changes。即时事件一般只传一条;回溯事件需传入全部历史更新。

Minimum array length: 1
start_at_seconds
integer<int64>

事件开始时间(Unix 秒)。存储的开始时间始终以第一条更新的 at_seconds 为准(该字段缺省时取当前时间);对于开启 auto_update_by_schedule 的维护事件,本字段用于调度自动切换为 ongoing 的任务。

responders
integer<int64>[]

事件负责成员的 ID 列表。

linked_changes
string[]

关联的事件 ID 列表(相关故障、发布等)。

close_at_seconds
integer<int64>

事件结束时间(Unix 秒),必须大于或等于第一条更新的 at_seconds。回溯事件用它表示结束时间;对于开启 auto_update_by_schedule 的维护事件,它用于调度自动切换为 completed 的任务,且距当前时间不能超过 30 天。

notify_subscribers
boolean

是否通知订阅者本事件及其所有更新。

auto_update_by_schedule
boolean

仅维护事件:根据计划窗口自动推进状态。

is_retrospective
boolean

标记为回溯(历史)事件。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

创建状态页事件的结果。