跳转到主要内容
POST
创建状态页

限制说明

使用说明

  • 状态页数量受 On-call 套餐限制:公开页免费版和标准版 1 个、专业版 5 个;内部页仅专业版可用,最多 20 个。超出返回 InvalidParameter。
  • url_name 会被规范化为小写 slug,且在账户内同类型状态页中必须唯一;响应中的 page_url_name 为最终值。
  • 公开页只支持邮件订阅,且只有公开页可设置 custom_domain;内部页只支持 IM 订阅。
  • 每次调用都会记录到账户审计日志,请勿在请求字段中写入敏感信息。

授权

app_key
string
query
必填

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

请求体

application/json
name
string
必填

状态页展示名称。

Maximum string length: 255
url_name
string
必填

URL 安全 slug;会规范化为小写,非字母数字字符替换为连字符,且在账户内同类型状态页中必须唯一。

Maximum string length: 255
type
enum<string>
必填

状态页可见性类型:public 任何人可访问,internal 仅本账号登录成员可见。

可用选项:
public,
internal
date_view
enum<string>
必填

事件日期展示方式:calendar 日历视图,list 列表视图。

可用选项:
calendar,
list
display_uptime_mode
enum<string>
必填

可用率展示方式:chart_and_percentage 图表加百分比,chart 仅图表,none 不展示。

可用选项:
chart_and_percentage,
chart,
none
custom_domain
string

自定义域名,仅公开页可设置,且不能被其他状态页占用。

Maximum string length: 255
page_title
string

为兼容保留的字段,服务端不会存储,传入无效果。

page_header
string

状态页页头内容。

状态页页脚内容。

状态页展示的自定义导航链接。

contact_info
string

联系信息,例如 mailto 或网站 URL。

subscription
object

订阅渠道开关,默认均为 false。公开页只能开启 email,内部页只能开启 im。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

接口返回的数据,格式见各接口的 200 响应。没有返回数据的接口会返回 {} 或完全不带 data。