Flashcat API
FlashdutyNightingaleFlashcat帮助文档官网控制台
FlashdutyNightingaleFlashcat帮助文档官网控制台
  1. 告警管理
  • 介绍
  • Open API
    • 快速入门
    • 关于分页
    • 成员管理
      • 邀请成员
      • 重置信息
      • 删除成员
      • 成员列表
    • 团队管理
      • 团队列表
      • 基本信息
      • 团队删除
      • 团队Upsert
    • 值班管理
      • 创建值班表
      • 更新值班表
      • 预览值班表
      • 删除值班表
      • 查看值班详情
      • 查看值班列表
      • 个人值班日程
      • 根据ID列表获取值班表信息
      • 角色信息
    • 信息获取
      • 人员
      • 团队
      • 协作空间
    • 偏好设置
      • 查看偏好设置
      • 修改偏好设置
    • 协作空间
      • 分派策略
        • 策略详情
        • 策略启用
        • 策略禁用
        • 策略删除
        • 策略列表
        • 策略创建
        • 策略更新
      • 订阅规则
        • 策略启用
        • 策略禁用
        • 策略删除
        • 策略列表
        • 策略创建
        • 策略更新
      • 排除规则
        • 策略启用
        • 策略禁用
        • 策略删除
        • 策略列表
        • 策略创建
        • 策略更新
      • 静默策略
        • 策略启用
        • 策略禁用
        • 策略删除
        • 策略列表
        • 策略创建
        • 策略更新
      • 抑制策略
        • 策略启用
        • 策略禁用
        • 策略删除
        • 策略列表
        • 策略创建
        • 策略更新
      • 空间列表
      • 空间详情
      • 空间创建
      • 空间更新
      • 空间启用
      • 空间禁用
      • 空间删除
      • 空间排序
      • 空间收藏
      • 取消收藏
      • 机器人列表
      • 按集成查询空间名称
    • 模板管理
      • 模板列表
      • 模板详情
      • 模板启用
      • 模板禁用
      • 模板删除
      • 模板预览
      • 模板创建
      • 模板更新
    • 故障管理
      • 聚合视图
        • 视图删除
        • 视图列表
        • 视图创建
        • 视图更新
      • 创建故障
      • 分派故障
      • 添加处理人
      • 认领故障
      • 取消认领
      • 关闭故障
      • 重开故障
      • 删除故障
      • 屏蔽故障
      • 取消屏蔽
      • 合并故障
      • 评论故障
      • 故障详情
      • 故障列表
      • 故障列表-卡片视图
      • 故障列表-按ID查询
      • 历史故障列表
      • 故障时间线
      • 标题更新
      • 描述更新
      • 影响更新
      • 根因更新
      • 解决方案更新
      • 严重程度更新
      • 关联告警列表
      • 自定义字段更新
      • 触发自定义操作
    • 告警管理
      • 聚合视图
        • 视图删除
        • 视图列表
        • 视图创建
        • 视图更新
      • 告警详情
        POST
      • 关闭告警
        POST
      • 告警列表-卡片视图
        POST
      • 告警列表
        POST
      • 告警列表-按ID查询
        POST
      • 关联-事件列表
        POST
      • 时间线
        POST
      • 合并到故障
        POST
    • 变更管理
      • 变更列表
    • 自定义字段
      • 字段列表
      • 字段详情
      • 字段删除
      • 字段创建
      • 字段更新
    • 服务日历
      • 日历列表
      • 日历详情
      • 日历创建
      • 日历更新
      • 日历删除
      • 日历事件设置
      • 日历事件删除
      • 日历事件列表
    • 标签增强
      • Mapping
        • 查询schema
        • 创建schema
        • 更新schema
        • 删除schema
        • 查询data
        • 更新data
        • 删除data
        • 清空data
        • csv上传data
        • csv下载data
      • 规则详情
      • 规则更新
    • 告警处理
      • 规则详情
      • 规则更新
    • 集成路由
      • 路由历史列表
      • 路由列表
      • 路由详情
      • 路由更新
    • License管理
      • License成员列表
      • 修改成员License类型
    • 分析看板
      • 告警标签TOP
      • 账户维度指标
      • 故障明细查询
      • 故障明细导出
      • 团队维度指标
      • 团队维度指标导出
      • 空间维度指标
      • 空间维度指标导出
      • 个人维度指标
      • 个人维度指标导出
      • 通知数量
      • 变更数量
  • Webhook
    • 快速入门
    • 自定义操作
    • 故障 Webhook
    • 告警 Webhook
  • Event API
    • 快速入门
    • 告警 Event
    • 变更 Event
  1. 告警管理

告警详情

POST
/alert/info
最后修改时间:2023-09-14 07:15:52

请求参数

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
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.flashcat.cloud/alert/info?app_key' \
--header 'Content-Type: application/json' \
--data-raw '{
    "alert_id": "string"
}'

返回响应

🟢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
  }
}

添加官方技术人员微信

在这里,获得使用上的任何帮助,快速上手企业告警一站式响应平台FlashDuty

微信扫码交流
修改于 2023-09-14 07:15:52
上一页
视图更新
下一页
关闭告警
Built with