Flashcat API
FlashdutyNightingaleFlashcat帮助文档官网控制台
FlashdutyNightingaleFlashcat帮助文档官网控制台
  1. 数据查询
  • 介绍
  • 灭火图 API
    • 快速入门
    • 树结构管理
      • 层级管理
        • 层级列表
        • 新增/修改层级
        • 删除层级
        • 启用层级
        • 禁用层级
        • 修改层级的顺序
      • 业务线管理
        • 新增/修改业务线
        • 删除业务线
        • 业务线详情
        • 业务线列表
        • 修改业务线的顺序
      • 分组管理
        • 新增/修改分组
        • 新增/修改分组 - 模块分页
        • 删除分组
        • 分组详情
        • 分组列表
        • 分组列表 - 模块分页
        • 修改分组的顺序
      • 树结构 - 当前空间的整棵树
    • 卡片管理
      • 新增/修改卡片
      • 卡片名称冲突校验
      • 卡片详情
      • 业务线下的卡片列表
      • 分组内的卡片列表
      • 添加单个卡片到分组中
      • 从分组移除单个卡片
    • 数据查询
      • 查看首页所有业务线的实时状态
        GET
      • 查看任意卡片的snapshot
        POST
      • 查看卡片指标的历史数据
        POST
    • 词表管理
      • 标签增强词表管理
        • 获取词表列表
        • 获取特定词表
        • 新建 / 更新词表
        • 删除特定词表
  • 空间管理
    • 查看空间列表
      GET
  • 北极星 API
    • 快速入门
    • 业务线管理
      • 新增/修改业务线
      • 业务线配置
      • 业务线列表
      • 删除业务线
    • 指标管理
      • 新增/修改 指标
      • 禁用指标
      • 启用指标
      • 删除指标
      • 指标列表
      • 指标详情
      • 指标名称的唯一性冲突校验
      • 指标的历史数据
    • 图表管理
      • 新增/修改图表
      • 图表详情
      • 图表列表
      • 删除图表
    • 事件气泡管理
      • 新增/修改事件
      • 事件详情
      • 事件列表
      • 删除事件
  1. 数据查询

查看任意卡片的snapshot

POST
/api/v2/firemap/snapshot
最后修改时间:2024-03-15 07:20:37

请求参数

Header 参数
Content-Type
string 
必需
示例值:
application/json
FC-WORKSPACE-ID
string 
可选
示例值:
823147571215
Body 参数application/json
timestamp
integer 
必需
append_topology
boolean 
补齐关联关系信息
可选
拓扑大屏中调用时使用
append_accu
string 
补齐天周月季的数据
必需
firemap
array [object {5}] 
按ID列表查询
必需
旧的字段,待下线,切换成 .cards即可
uuid
string 
必需
business_id
integer 
可选
firemap_type
string 
可选
group_id
integer 
必需
card_id
integer 
必需
示例
{
  "timestamp": 0,
  "append_topology": true,
  "firemap": [
    {
      "uuid": "灭火图分组",
      "business_id": 1281,
      "group_id": 1392
    },
    {
      "uuid": "灭火图卡片",
      "business_id": 1281,
      "card_id": 1712
    }
  ]
}

示例代码

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/api/v2/firemap/snapshot' \
--header 'FC-WORKSPACE-ID: 823147571215' \
--header 'Content-Type: application/json' \
--data-raw '{
    "timestamp":0,
    "append_topology":true,
    "firemap":[
        {
            "uuid": "灭火图分组",
            "business_id":1281,
            "group_id":1392
        },
        {
            "uuid": "灭火图卡片",
            "business_id":1281,
            "card_id":1712
        }
    ]
}'

返回响应

🟢200成功
application/json
Body
request_id
string 
必需
data
array [object {25}] 
必需
uuid
string 
必需
automatic
boolean 
必需
enable
boolean 
必需
is_path_exist
boolean 
必需
is_accessible
boolean 
必需
firemap_type
string 
必需
firemap_level
string 
必需
business_group_id
integer 
必需
business_group_name
string 
必需
business_id
integer 
必需
business_name
string 
必需
branch_id
integer 
必需
branch_name
string 
必需
group_id
integer 
可选
group_name
string 
可选
is_null
boolean 
必需
is_critical
boolean 
必需
is_relation_exist
boolean 
必需
card_id
integer 
可选
card_name
string 
可选
data_source_type
string 
可选
num_of_continuous
integer 
可选
values
object 
可选
anomaly_score
number 
可选
thresholds
array [object {5}] 
可选
示例
{
  "request_id": "string",
  "data": [
    {
      "uuid": "string",
      "automatic": true,
      "enable": true,
      "is_path_exist": true,
      "is_accessible": true,
      "firemap_type": "string",
      "firemap_level": "string",
      "business_group_id": 0,
      "business_group_name": "string",
      "business_id": 0,
      "business_name": "string",
      "branch_id": 0,
      "branch_name": "string",
      "group_id": 0,
      "group_name": "string",
      "is_null": true,
      "is_critical": true,
      "is_relation_exist": true,
      "card_id": 0,
      "card_name": "string",
      "data_source_type": "string",
      "num_of_continuous": 0,
      "values": {
        "ratio_day": 0,
        "ratio_month": 0,
        "ratio_quarter": 0,
        "ratio_week": 0,
        "succrate": 0
      },
      "anomaly_score": 0,
      "thresholds": [
        {
          "metric": "string",
          "name": "string",
          "threshold": 0,
          "operator": "string",
          "logic": "string"
        }
      ]
    }
  ]
}

添加官方技术人员微信

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

微信扫码交流
修改于 2024-03-15 07:20:37
上一页
查看首页所有业务线的实时状态
下一页
查看卡片指标的历史数据
Built with