告警详情 - Flashcat API

请求参数

Authorization

在 query 添加参数

app_key

示例：

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

Header 参数

Content-Type

string

必需

示例值:

application/json

Body 参数application/json

alert_id

string

告警ID

必需

示例

{
  "alert_id": "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/alert/info?app_key' \
--header 'Content-Type: application/json' \
--data-raw ''

返回响应

🟢200成功

application/json

Body

error

object (DutyError)

错误信息

可选

code

enum<string>

错误码

必需

枚举值:

InvalidParameterInvalidContentTypeUnauthorizedAccessDeniedMethodNotAllowedRequestTooFrequentlyRequestVerifyRequiredDangerousOperationRequestLockedRouteNotFoundBalanceNotEnoughUndonedOrderExistResourceNotFoundInternalErrorReferenceExist

message

string

错误描述

必需

data

object (Alert)

数据对象

可选

alert_id

string

告警ID

必需

channel_id

integer

协作空间ID

必需

channel_name

string

协作空间名称

必需

data_source_id

integer

集成ID

必需

data_source_name

string

集成名称

必需

data_source_type

string

集成类型

必需

data_source_ref_id

string

集成关联ID

必需

title

string

标题

必需

title_rule

string

标题规则

可选

description

string

描述

可选

alert_key

string

事件关联依据

必需

拥有相同alert_key的告警事件，将合并为同一个告警

alert_severity

enum<string>

严重程度

必需

枚举值:

InfoWarningCritical

alert_status

enum<string>

告警状态

必需

枚举值:

InfoWarningCriticalOk

progress

enum<string>

处理进度

必需

枚举值:

TriggeredProcessingClosed

start_time

integer

首次触发时间

必需

告警可能频繁发生与恢复，该值为首次触发时间

last_time

integer

上次合并事件时间

必需

仅当合入新告警事件时，进行更新，不同于updated_at

end_time

integer

告警结束时间

可选

当告警恢复时，进行更新。自动恢复，告警将自动关闭，会同时更新close_time

close_time

integer

人工结束处理时间

可选

关闭不影响告警恢复

created_at

integer

创建时间

必需

数据库记录的创建时间，一般和start_time想同

updated_at

integer

更新时间

必需

数据库记录的更新时间，和last_time不同，手动或自动更新告警，该字段都会进行更新

labels

object (Labels)

标签列表

必需

events

array[object (AlertEvent) {11}]

关联事件

可选

responder_id

integer

处理人ID

可选

incident

object

关联故障

可选

event_cnt

integer

累计聚合事件数量

可选

ever_muted

boolean

是否被静默/抑制过

可选

示例

{
  "error": {
    "code": "InvalidParameter",
    "message": "string"
  },
  "data": {
    "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
  }
}