跳转到主要内容
POST
/
incident
/
list
查询故障列表
curl --request POST \
  --url 'https://api.flashcat.cloud/incident/list?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "start_time": 1711900800,
  "end_time": 1712000000,
  "progress": "Triggered,Processing",
  "incident_severity": "Critical,Warning",
  "channel_ids": [
    2551105804131
  ],
  "limit": 20,
  "p": 1
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "total": 88,
    "has_next_page": true,
    "search_after_ctx": "69da451ef77b1b51f40e83eb",
    "items": [
      {
        "incident_id": "69da451ef77b1b51f40e83ee",
        "account_id": 2451002751131,
        "channel_id": 2551105804131,
        "integration_id": 2490562293131,
        "integration_ids": [
          2490562293131
        ],
        "integration_types": [
          "monit.alert"
        ],
        "dedup_key": "100128:prom-10.99.1.107:A:1579244238440766834:anydata",
        "equals_md5": "",
        "start_time": 1775912219,
        "end_time": 0,
        "last_time": 1775969819,
        "ack_time": 0,
        "close_time": 0,
        "creator_id": 0,
        "closer_id": 0,
        "owner_id": 0,
        "incident_status": "Critical",
        "incident_severity": "Critical",
        "progress": "Triggered",
        "title": "CPU usage high - web-server-01",
        "description": "",
        "ai_summary": "",
        "impact": "",
        "root_cause": "",
        "resolution": "",
        "num": "0E83EE",
        "frequency": "frequent",
        "created_at": 1775912222,
        "updated_at": 1775972145,
        "snoozed_before": 0,
        "group_method": "n",
        "ever_muted": false,
        "labels": {
          "check": "cpu_usage_high",
          "resource": "web-server-01",
          "env": "production"
        },
        "fields": {},
        "assigned_to": {
          "person_ids": [
            2476444212131
          ],
          "escalate_rule_id": "000000000000000000000000",
          "layer_idx": 0,
          "type": "assign",
          "assigned_at": 1775972128,
          "id": "MvQfH9Dc8eNS8k79jmrWn6",
          "escalate_rule_name": ""
        },
        "alert_cnt": 1,
        "active_alert_cnt": 1,
        "alert_event_cnt": 17,
        "responders": [
          {
            "person_id": 2476444212131,
            "assigned_at": 1775972128,
            "acknowledged_at": 0
          }
        ],
        "account_name": "",
        "account_locale": "",
        "account_time_zone": "",
        "channel_name": "Ops Channel",
        "channel_status": "enabled",
        "detail_url": "https://app.flashcat.cloud/incident/detail/69da451ef77b1b51f40e83ee",
        "silence_url": "https://app.flashcat.cloud/channel/detail/2551105804131?tab=alertSuppression&fromIncidentId=69da451ef77b1b51f40e83ee",
        "integration_type": "monit.alert",
        "post_mortem_id": "",
        "images": null,
        "manual_overrides": [
          "title"
        ]
      }
    ]
  }
}

限制说明

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

授权

app_key
string
query
必填

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

请求体

application/json

查询故障列表的过滤条件。start_timeend_time 必填,时间窗口不超过 31 天。

start_time
integer<int64>
必填

时间窗口起点(Unix 秒)。

end_time
integer<int64>
必填

时间窗口终点(Unix 秒),必须大于 start_time 且不超过 31 天。

asc
boolean

true 为升序。

is_snoozed
boolean

true 时仅返回已暂停通知的故障。

is_my_team
boolean

true 时仅返回用户所属团队管理的协作空间中的故障。

is_my_channel
boolean

true 时仅返回用户个人管理的协作空间中的故障。

ever_muted
boolean

true 时仅返回曾被静默的故障。

is_rare
boolean

true 时仅返回新奇故障。

progress
string

进展状态过滤,逗号分隔(如 Triggered,Processing)。

query
string

全文搜索关键词。

incident_severity
string

严重程度过滤,逗号分隔(Critical,Warning,Info)。

channel_ids
integer<int64>[]

协作空间 ID 列表,0 表示独立故障。

team_ids
integer<int64>[]

团队 ID 列表,通过协作空间所属团队进行解析。

responder_ids
integer<int64>[]

处理人员成员 ID。

acker_ids
integer<int64>[]

认领人员成员 ID。

creator_ids
integer<int64>[]

创建人员成员 ID,0 表示自动创建。

closer_ids
integer<int64>[]

关闭人员成员 ID,0 表示自动关闭。

incident_ids
string[]

指定故障 ID 列表进行过滤。

nums
string[]

按短标识过滤。

p
integer<int64>

页码,从 1 开始。

必填范围: x >= 0
limit
integer<int64>
默认值:20

分页大小,最大 100。

必填范围: 0 <= x <= 100
search_after_ctx
string

上一次响应返回的翻页游标。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

故障分页列表。