故障列表 - Flashcat API

请求参数

Authorization

在 query 添加参数

app_key

示例：

app_key: ********************

Header 参数

Content-Type

string

必需

示例值:

application/json

Body 参数application/json

search_after_ctx

string

游标分页，不设置为第一页。与p参数二选一

可选

详细解释，请参考关于分页

p

integer

传统分页，不设置从第一页开始，默认值为1，与search_after_ctx参数二选一

可选

基于传统分页时设置，当设置p参数时，p*limit不得超过10000，否则返回参数错误。详细解释，请参考关于分页

默认值:

1

limit

integer

分页条数

可选

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

>= 0<= 100

默认值:

20

asc

boolean

是否升序

可选

默认排序依据为故障创建时间，start_time

progress

string

处理状态

可选

Triggered,Processing,Closed 全部（progress不传）未关闭（progress传Triggered,Processing）待处理（progress传Triggered）处理中（progress传Processing）已关闭（progress传Closed）

title

string

故障标题

可选

默认为精确查询

channel_ids

array[integer]

协作空间ID列表

可选

0代表全局故障

responder_ids

array[integer]

处理人ID列表

可选

处理人可能包含未认领的已分派人员

acker_ids

array[integer]

认领人ID列表

可选

creator_ids

array[integer]

创建人ID列表

可选

0代表系统聚合产生的故障，不为0为手动创建的故障

incident_ids

array[string]

故障ID列表

可选

start_time

integer

检索区间起点

必需

单位秒，end_time-start_time不能超过1个月

end_time

integer

检索区间终点

必需

单位秒，end_time-start_time不能超过1个月

incident_severity

enum<string>

严重程度

可选

Critical,Info,Warning 可以传多个，逗号分隔

枚举值:

CriticalWarningInfo

is_related

boolean

是否与我相关

可选

登录人为发起人、被指派、关闭人或处理人之一

is_snoozed

boolean

是否暂缓中

可选

仅看当前状态，与查询时间区间无关

is_my_team

boolean

我团队的

可选

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

is_my_channel

boolean

我的空间

可选

当设置为true，仅统计我的空间（我所在团队下属协作空间以及我个人创建的协作空间）下的故障

labels

object (Labels)

标签筛选

可选

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

^[a-zA-Z_][a-zA-Z0-9_]*$

string

(pattern property)

key为任意label名称，值为字符串

可选

label格式需要满足正则^[a-zA-Z_][a-zA-Z0-9_]*$，value的长度不超过512字节

<= 512 字符

fields

object

自定义字段筛选

可选

仅支持精确匹配

{x}

x为任意自定义字段名称，值可为多种类型，具体根据自定义字段配置进行传参

必需

示例

{
  "search_after_ctx": "string",
  "p": 1,
  "limit": 20,
  "asc": true,
  "progress": "string",
  "title": "string",
  "channel_ids": [
    0
  ],
  "responder_ids": [
    0
  ],
  "acker_ids": [
    0
  ],
  "creator_ids": [
    0
  ],
  "incident_ids": [
    "string"
  ],
  "start_time": 0,
  "end_time": 0,
  "incident_severity": "Critical",
  "is_related": true,
  "is_snoozed": true,
  "is_my_team": true,
  "is_my_channel": true,
  "labels": {},
  "fields": {
    "{x}": "string"
  }
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.flashcat.cloud/incident/list?app_key' \
--header 'Content-Type: application/json' \
--data-raw '{
    "search_after_ctx": "string",
    "p": 1,
    "limit": 20,
    "asc": true,
    "progress": "string",
    "title": "string",
    "channel_ids": [
        0
    ],
    "responder_ids": [
        0
    ],
    "acker_ids": [
        0
    ],
    "creator_ids": [
        0
    ],
    "incident_ids": [
        "string"
    ],
    "start_time": 0,
    "end_time": 0,
    "incident_severity": "Critical",
    "is_related": true,
    "is_snoozed": true,
    "is_my_team": true,
    "is_my_channel": true,
    "labels": {},
    "fields": {
        "{x}": "string"
    }
}'

返回响应

🟢200成功

application/json

Body

error

object (DutyError)

可选

code

enum<string>

错误码

必需

枚举值:

InvalidParameterInvalidContentTypeUnauthorizedAccessDeniedMethodNotAllowedRequestTooFrequentlyRequestVerifyRequiredDangerousOperationRequestLockedRouteNotFoundBalanceNotEnoughUndonedOrderExistResourceNotFoundInternalErrorReferenceExist

message

string

错误描述

必需

data

object

可选

items

array[object (Incident) {30}]

故障条目

可选

search_after_ctx

string

可选

游标分页，有此项说明有下一页。详细解释，请参考关于分页

total

integer

可选

匹配条目总数。请注意，total仅在小于1000时精确，请不要使用该值来计算分页是否结束。当总条数大于1000时，系统仅会返回total=1000，代表系统匹配到了1000+数据。请使用hax_next_page来判断是否还有数据未获取。详细解释，请参考关于分页

has_next_page

boolean

可选

是否存在更多数据未获取

示例

{
  "error": {
    "code": "InvalidParameter",
    "message": "string"
  },
  "data": {
    "items": [
      {
        "incident_id": "string",
        "start_time": 0,
        "end_time": 0,
        "last_time": 0,
        "ack_time": 0,
        "close_time": 0,
        "snoozed_before": 0,
        "incident_status": "Info",
        "incident_severity": "Info",
        "progress": "Triggered",
        "creator_id": 0,
        "closer_id": 0,
        "assigned_to": {
          "person_ids": [
            0
          ],
          "escalate_rule_id": "string",
          "escalate_rule_name": "string",
          "layer_idx": 0,
          "layer_person_reset": {
            "0": {
              "team_ids": [
                0
              ],
              "person_ids": [
                0
              ],
              "schedule_to_role_ids": {
                "{schedule_id}": [
                  0
                ]
              }
            }
          },
          "type": "assign"
        },
        "responders": [
          {
            "person_id": 0,
            "assigned_at": 0,
            "acknowledged_at": 0
          }
        ],
        "alert_cnt": 0,
        "title": "string",
        "description": "string",
        "impact": "string",
        "root_cause": "string",
        "resolution": "string",
        "num": "string",
        "labels": {},
        "channel_id": 0,
        "channel_name": "string",
        "data_source_id": 0,
        "data_source_type": "string",
        "dedup_key": "string",
        "group_method": "i",
        "ever_muted": true,
        "frequency": "string"
      }
    ],
    "search_after_ctx": "string",
    "total": 0,
    "has_next_page": true
  }
}