跳转到主要内容
POST
/
incident
/
create
创建故障
curl --request POST \
  --url 'https://api.flashcat.cloud/incident/create?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "incident_severity": "Critical",
  "title": "Database connection timeout on prod-db-01",
  "channel_id": 2551105804131,
  "assigned_to": {
    "person_ids": [
      2476444212131
    ]
  }
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "incident_id": "69db2ef1a0fe7db6448b14f1",
    "title": "API test incident for docs"
  }
}

限制说明

项目说明
速率限制每个账户 1,000 次/分钟50 次/秒
权限要求故障管理on-call

授权

app_key
string
query
必填

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

请求体

application/json

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

incident_severity
enum<string>
必填

故障严重程度。

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

故障标题,最多 512 个字符。

Maximum string length: 512
description
string

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

Maximum string length: 1024
channel_id
integer<int64>

归属的协作空间 ID,留空表示独立故障。

assigned_to
object

故障处理人员指派目标。person_idsescalate_rule_id 至少设置一项。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

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