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

变更 Event

通过标准 API 推送自有系统变更事件到快猫星云,大部分故障由变更导致,变更和告警事件联动有助于快速定位故障原因。

请求描述

请求方式

POST, Content-Type:"application/json"

请求参数:

QueryString 必须需要包含参数 integration_key,用于访问控制。

JsonBody 参数如下:

字段必含类型释义
change_status是string变更 event 状态,枚举值:Planned:已提单,Ready:即将(或计划)开始,Processing:进行中,Canceled:已取消(或回滚),Done:已完成。不要求全部状态都上报,可选择性上报
change_key是string变更唯一 key,一般是变更单号。用于将不同的变更 event 合并至一个变更
title是string变更 title
event_time否int64变更 event 发生时间戳,单位“秒”,如果 change_status 为 Ready 状态,可以上报未来时间;如果不传,则使用当前时间
description否string变更描述,不超过 2048 个字符
link否string变更单地址,用于跳转到变更详情
labels否map变更标签集合,key 为标签名称,value 为标签值。标签是事件的描述,用于后续的关联,非常重要。1. 标签的 key 和 value 均为 string 类型,区分大小写。2. 标签的 key 不要超过 128 个字符。3. 至多传入 50 个标签。标签内容参考最佳实践

请求响应

Body:

参数名称必选类型描述
request_id是string请求 trace id,用于问题追踪
error否Error错误描述,仅当出现错误时返回


Error:

参数名称可选类型描述
code是string错误码
message是string错误描述


Code:

错误码HTTP Status描述
InvalidParameter400参数错误
InvalidContentType400Conten-Type 不支持
MethodNotAllowed400http method 不支持
Unauthorized401登录认证失败
AccessDenied403权限认证失败
RequestTooFrequently429请求过于频繁
RouteNotFound404请求Method+Path未匹配
ResourceNotFound400账户未购买资源,前往费用中心线操作下单
InternalError500内部或未知错误

请求示例

请求:

curl -X POST 'https://api.flashcat.cloud/event/push/change/standard?integration_key=$key' \
-H 'Content-Type: application/json' \
-d '{
    "change_status": "Done",
    "change_key": "CHANGE-002",
    "description": "进度100%",
    "title": "双12活动",
    "labels": {
        "service": "flashcat",
        "cluster":"nj"
    },
    "link": "http://jira.flashcat.cloud/CHANGE-001"
}'

成功响应:

{
    "request_id": "0ace00116215ab4ca0ec5244b8fc54b0"
}

失败响应:

{
    "request_id": "0ace00116215abc0ba4e52449bd305b0",
    "error": {
        "code": "InvalidParameter",
        "message": "integration_key $key is not a valid one"
    }
}

最佳实践

标签是事件的描述,应尽量丰富标签内容,比如:

  1. 变更的应用范围,如 host,cluster 等
  2. 变更的归属信息,如 team,owner 等

添加官方技术人员微信

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

微信扫码交流
修改于 2024-11-21 11:08:17
上一页
告警 Event
Built with