跳转到主要内容
POST
创建或更新状态页组件

限制说明

使用说明

  • 不带 component_id 的条目会创建组件;带 component_id 的条目更新对应组件。
  • 更新会用请求值覆盖 name、description、section_id、order_id、hide_uptime 和 hide_all,未传字段会被重置(不传 section_id 会把组件移到顶层);更新时忽略 available_since_seconds。
  • 组件名称在状态页内必须唯一,section_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 获取。

components
object[]
必填

要创建或更新的组件列表。

Minimum array length: 1

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

创建或更新状态页组件的结果。