跳转到主要内容
POST
创建故障

限制说明

使用说明

  • 账户未配置创建表单时,只有 incident_severity 必填。
  • 账户配置了创建表单时,title(非空)、channel_id 和 assigned_to 变为必填;fields 只能包含表单中可见的自定义字段,且表单的必填字段必须填写。
  • 仅当创建表单包含图片上传元素时才能附加图片(最多 10 张):使用 multipart/form-data,在 data 中传 JSON 请求体,在 images 中传文件;整个请求不得超过 50 MiB。
  • 分派在故障创建之后执行。未传 assigned_to 时由协作空间的分派策略决定;未传 assigned_to 的独立故障不会有处理人员。分派失败(例如 layer_idx 越界)时故障仍会创建,只是没有处理人员。

授权

app_key
string
query
必填

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

请求体

手动创建故障所需的参数。

incident_severity
enum<string>
必填

故障严重程度:Info 提示、Warning 警告、Critical 严重。

可用选项:
Info,
Warning,
Critical
title
string

故障标题,最多 512 个字符。账户配置了创建表单时必填且不能为空。

Maximum string length: 512
description
string

故障描述,最多 1024 个字符。

Maximum string length: 1024
channel_id
integer<int64>

故障所属的协作空间,须在账户中存在。除非账户配置了创建表单,否则可不填;不填即为独立故障。

assigned_to
object

分派对象。省略或为空时由协作空间的分派策略决定(独立故障不会有处理人员);账户配置了创建表单时必填。person_ids、team_ids、escalate_rule_id 和 emails 可同时设置,处理人员取并集。分派在创建之后执行,分派失败不会撤销故障。

fields
object

以字段名为键的自定义字段值。创建表单生效时,只接受表单中可见的字段。

labels
object

新建故障时写入的标签,最多 50 个。空值会被丢弃。key 中的空格和部分标点会替换为 _;key 和 value 会去掉首尾空白,value 截断到 8 KiB。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

手动创建故障的返回结果。