告警列表-卡片视图

请求参数

Authorization

在 query 添加参数

app_key

示例：

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

Body 参数application/json

view_id

string

视图ID

必需

progress

string

处理状态

可选

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

title

string

标题筛选

可选

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

channel_id

integer

channel ID

可选

data_source_id

integer

集成ID

可选

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

alert_severity

string

等级

可选

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

is_my_channel

boolean

是否我的channel

可选

仅筛选与我相关的channel下的告警

ever_muted

boolean

是否被静默或抑制过

可选

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

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

示例

{
  "view_id": "string",
  "progress": "string",
  "title": "string",
  "channel_id": 0,
  "data_source_id": 0,
  "start_time": 0,
  "end_time": 0,
  "alert_severity": "string",
  "is_my_channel": true,
  "ever_muted": true,
  "labels": {}
}

示例代码

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-by-card?app_key' \
--header 'Content-Type: application/json' \
--data-raw '{
    "view_id": "string",
    "progress": "string",
    "title": "string",
    "channel_id": 0,
    "data_source_id": 0,
    "start_time": 0,
    "end_time": 0,
    "alert_severity": "string",
    "is_my_channel": true,
    "ever_muted": true,
    "labels": {}
}'

返回响应

🟢200成功

application/json

Body

error

object (DutyError)

可选

code

enum<string>

错误码

必需

枚举值:

InvalidParameterInvalidContentTypeUnauthorizedAccessDeniedMethodNotAllowedRequestTooFrequentlyRequestVerifyRequiredDangerousOperationRequestLockedRouteNotFoundBalanceNotEnoughUndonedOrderExistResourceNotFoundInternalErrorReferenceExist

message

string

错误描述

必需

data

object

可选

items

array [object {4}]

必需

请注意，匹配超过100条数时，仅返回100条

示例

{
  "error": {
    "code": "InvalidParameter",
    "message": "string"
  },
  "data": {
    "items": [
      {
        "title": "string",
        "total": 0,
        "alert_severity": "string",
        "alert_ids": [
          "string"
        ]
      }
    ]
  }
}