告警列表 - Flashcat API

请求参数

Authorization

在 query 添加参数

app_key

示例：

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

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

是否升序

可选

默认按照created_at倒序

orderby

string

排序依据

可选

支持created_at updated_at，默认为created_at

title

string

标题筛选

可选

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

progress

string

处理状态

可选

Triggered,Closed
全部（progress不传）
未关闭（progress传Triggered）
已关闭（progress传Closed）

alert_severity

string

等级

可选

Critical，Info， Warning支持传多个，用逗号分割

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 字符

channel_ids

array[integer]

协作空间列表

可选

data_source_ids

array[integer]

集成来源列表

可选

alert_ids

array[string]

告警ID列表

必需

ever_muted

boolean

是否被静默或抑制过

可选

不传查全部，传true仅返回被静默或抑制的告警，传false仅返回未被抑制过的告警

start_time

integer

开始时间戳

必需

该时间为query的start_time，与告警的start_time无关。实际检索条件为：alert.start_time<=query.end_time and alert.last_time>=query.start_time

end_time

integer

结束时间

必需

该时间为query的end_time，与告警的end_time无关。实际检索条件为：alert.start_time<=query.end_time and alert.last_time>=query.start_time

示例

{
  "search_after_ctx": "string",
  "p": 1,
  "limit": 20,
  "asc": true,
  "orderby": "string",
  "title": "string",
  "progress": "string",
  "alert_severity": "string",
  "labels": {},
  "channel_ids": [
    0
  ],
  "data_source_ids": [
    0
  ],
  "alert_ids": [
    "string"
  ],
  "ever_muted": true,
  "start_time": 0,
  "end_time": 0
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.flashcat.cloud/alert/list?app_key' \
--header 'Content-Type: application/json' \
--data-raw ''

返回响应

🟢200成功

application/json

Body

error

object (DutyError)

可选

code

enum<string>

错误码

必需

枚举值:

InvalidParameterInvalidContentTypeUnauthorizedAccessDeniedMethodNotAllowedRequestTooFrequentlyRequestVerifyRequiredDangerousOperationRequestLockedRouteNotFoundBalanceNotEnoughUndonedOrderExistResourceNotFoundInternalErrorReferenceExist

message

string

错误描述

必需

data

object

可选

items

array[object (Alert) {26}]

告警条目

可选

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": [
      {
        "alert_id": "string",
        "channel_id": 0,
        "channel_name": "string",
        "data_source_id": 0,
        "data_source_name": "string",
        "data_source_type": "string",
        "data_source_ref_id": "string",
        "title": "string",
        "title_rule": "string",
        "description": "string",
        "alert_key": "string",
        "alert_severity": "Info",
        "alert_status": "Info",
        "progress": "Triggered",
        "start_time": 0,
        "last_time": 0,
        "end_time": 0,
        "close_time": 0,
        "created_at": 0,
        "updated_at": 0,
        "labels": {},
        "events": [
          {
            "event_id": "string",
            "data_source_id": 0,
            "channel_id": 0,
            "title": "string",
            "title_rule": "string",
            "description": "string",
            "alert_id": "string",
            "event_status": "Info",
            "event_severity": "Info",
            "event_time": 0,
            "labels": {}
          }
        ],
        "responder_id": 0,
        "incident": {
          "incident_id": "string",
          "title": "string"
        },
        "event_cnt": 0,
        "ever_muted": true
      }
    ],
    "search_after_ctx": "string",
    "total": 0,
    "has_next_page": true
  }
}