跳转到主要内容
POST
/
incident
/
list
故障列表
curl --request POST \
  --url 'https://api.flashcat.cloud/incident/list?app_key=' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "start_time": 123,
  "end_time": 123,
  "search_after_ctx": "<string>",
  "p": 1,
  "limit": 20,
  "asc": true,
  "progress": "Triggered,Processing,Closed",
  "title": "<string>",
  "channel_ids": [
    123
  ],
  "responder_ids": [
    123
  ],
  "acker_ids": [
    123
  ],
  "creator_ids": [
    123
  ],
  "incident_ids": [
    "<string>"
  ],
  "incident_severity": "Critical",
  "is_related": true,
  "is_snoozed": true,
  "is_my_team": true,
  "is_my_channel": true,
  "ever_muted": true,
  "labels": {},
  "fields": {
    "{x}": "<string>"
  }
}
'
{
  "error": {
    "code": "<string>",
    "message": "<string>"
  },
  "data": {
    "items": [
      {
        "incident_id": "<string>",
        "start_time": 123,
        "end_time": 123,
        "last_time": 123,
        "snoozed_before": 123,
        "incident_status": "Info",
        "incident_severity": "Info",
        "progress": "Triggered",
        "creator_id": 123,
        "title": "<string>",
        "num": "<string>",
        "ack_time": 123,
        "close_time": 123,
        "closer_id": 123,
        "assigned_to": {
          "type": "assign",
          "person_ids": [
            123
          ],
          "escalate_rule_id": "<string>",
          "escalate_rule_name": "<string>",
          "layer_idx": 123
        },
        "responders": [
          {
            "person_id": 123,
            "assigned_at": 123,
            "acknowledged_at": 123
          }
        ],
        "alert_cnt": 123,
        "description": "<string>",
        "impact": "<string>",
        "root_cause": "<string>",
        "resolution": "<string>",
        "labels": {},
        "channel_id": 123,
        "channel_name": "<string>",
        "integration_ids": [
          123
        ],
        "integration_types": [
          "<string>"
        ],
        "dedup_key": "<string>",
        "group_method": "i",
        "ever_muted": true,
        "frequency": "rare",
        "images": [
          {
            "alt": "<string>",
            "src": "<string>",
            "href": "<string>"
          }
        ]
      }
    ],
    "search_after_ctx": "<string>",
    "total": 123,
    "has_next_page": true
  }
}

授权

app_key
string
query
必填

请求头

Content-Type
string
必填

请求体

application/json
start_time
integer
必填

检索区间起点。单位秒,end_time-start_time不能超过1个月

end_time
integer
必填

检索区间终点。单位秒,end_time-start_time不能超过1个月

search_after_ctx
string

游标分页,不设置为第一页。与p参数二选一。详细解释,请参考 关于分页

p
integer
默认值:1

传统分页,不设置从第一页开始,默认值为1,与search_after_ctx参数二选一。基于传统分页时设置,当设置p参数时,plimit不得超过10000** ,否则返回参数错误。详细解释,请参考 关于分页

limit
integer
默认值:20

分页条数。*当设置p参数时,(p-1)limit不得超过10000 ,否则返回参数错误。详细解释,请参考 关于分页

必填范围: 0 <= x <= 100
asc
boolean

是否升序,默认排序依据为故障创建时间,start_time

progress
enum<string>

处理状态,注意首字母大写,传入多个状态用”,“拼接

可用选项:
Triggered,Processing,Closed,
Triggered,Processing,
Triggered,
Processing,
Closed
title
string

故障标题:默认为精确查询,前后加"/"为正则匹配,包含”*“或"?"代表通配符匹配。

channel_ids
integer[]

协作空间ID列表

协作空间ID

responder_ids
integer[]

处理人(被分派人员)ID列表,处理人可能包含未认领的已分派人员

人员ID

acker_ids
integer[]

认领人ID列表

人员ID

creator_ids
integer[]

创建人ID列表,0代表系统聚合自动产生的故障,不为0为手动创建的故障

人员ID

incident_ids
string[]

故障ID列表

故障ID

incident_severity
enum<string>

严重程度。多个等级使用”,“分隔

可用选项:
Critical,
Warning,
Info

是否与查询人相关。登录人为发起人、被指派、关闭人或处理人之一

is_snoozed
boolean

是否暂缓中。仅看当前故障状态,与查询时间区间无关

is_my_team
boolean

我所在团队下的故障。当设置为true,仅统计我所在团队下属协作空间内的故障

is_my_channel
boolean

我所管理的协作空间下的故障。当设置为true,仅统计我的空间(我所在团队下属协作空间以及我个人创建的协作空间)下的故障

ever_muted
boolean

是否抖动提醒/暂缓过

labels
object

标签筛选。支持精确匹配、正则匹配和通配匹配。以'/'作为前后缀的字符串将被识别为正则。 举例:指定('datacenter' IN ['bj01','sh-*','']) AND ('host' IN '/api-server-\d+/'),可匹配到产生于'bj01'和'sh-01'、'sh-02'三个数据中心并且主机名满足'api-server-\d+'正则的报警事件

fields
object

自定义字段筛选。仅支持精确匹配,不支持text类型字段筛选,

响应

200 - application/json
error
object

仅出现错误时返回

data
object

响应数据