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

新增/修改卡片

POST
/api/v2/firemap/flexible/card/upsert
最后修改时间:2024-03-15 06:55:19
日志分析类型的卡片,暂不支持通过API添加

请求参数

Header 参数
Content-Type
string 
必需
示例值:
application/json
FC-WORKSPACE-ID
string 
必需
示例值:
1963865361927
Body 参数application/json
id
integer 
必需
name
string 
必需
owners
array[string]
可选
firemap_type
enum<string> 
必需
枚举值:
slomodule
order
integer 
必需
business_id
integer 
必需
business_name
string 
可选
group_id
integer 
可选
group_name
string 
可选
data_source_type
string 
必需
data_source_ids
array[integer]
必需
metrics
array [object {4}] 
必需
metric
string 
必需
name
string 
必需
settings
object 
必需
settings结构在不同的数据源中不同,详见样例
aggregation
string 
必需
multi_thresholds
array [object {4}] 
必需
thresholds
array [object {5}] 
可选
severity
integer 
可选
mode
enum<integer> 
模式
可选
枚举值:
01
expression
string 
可选
表达式模式下,有意义
示例
{
    "id": 1714,
    "name": "自定义模块指标-测试",
    "owners": [],
    "firemap_type": "module",
    "order": 0,
    "business_id": 1281,
    "business_name": "v2_测试",
    "group_id": 0,
    "group_name": "",
    "data_source_type": "prometheus",
    "data_source_ids": [
        241
    ],
    "metrics": [
        {
            "metric": "alive",
            "name": "实例存活率",
            "settings": {
                "prometheus.promql": "sum ( up { container =~ \"grafana\" } ) by ( container ) / count ( up { container =~ \"grafana\" } ) by ( container ) * 100"
            },
            "aggregation": "min"
        },
        {
            "metric": "cpu",
            "name": "CPU使用率",
            "settings": {
                "prometheus.promql": "sum ( irate ( container_cpu_usage_seconds_total { container =~ \"grafana\" } [5m] ) * 100 ) by ( pod )"
            },
            "aggregation": "max"
        },
        {
            "metric": "mem",
            "name": "MEM使用率",
            "settings": {
                "prometheus.promql": "sum ( container_memory_usage_bytes { container =~ \"grafana\", namespace = \"monitoring\" } ) by ( pod, container ) / sum ( container_spec_memory_limit_bytes { container =~ \"grafana\", namespace = \"monitoring\" } ) by ( pod, container ) * 100"
            },
            "aggregation": "max"
        }
    ],
    "thresholds": [
        {
            "metric": "alive",
            "threshold": 101,
            "operator": "<",
            "logic": "",
            "normalize": "percentage"
        }
    ],
    "multi_thresholds": [
        {
            "thresholds": [
                {
                    "metric": "alive",
                    "threshold": 101,
                    "operator": "<",
                    "logic": "",
                    "normalize": "percentage"
                },
                "severity": 1
            ]
        }
    ]
}

示例代码

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/flexible/card/upsert' \
--header 'FC-WORKSPACE-ID: 1963865361927' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": 1714,
    "name": "自定义模块指标-测试",
    "owners": [],
    "firemap_type": "module",
    "order": 0,
    "business_id": 1281,
    "business_name": "v2_测试",
    "group_id": 0,
    "group_name": "",
    "data_source_type": "prometheus",
    "data_source_ids": [
        241
    ],
    "metrics": [
        {
            "metric": "alive",
            "name": "实例存活率",
            "settings": {
                "prometheus.promql": "sum ( up { container =~ \"grafana\" } ) by ( container ) / count ( up { container =~ \"grafana\" } ) by ( container ) * 100"
            },
            "aggregation": "min"
        },
        {
            "metric": "cpu",
            "name": "CPU使用率",
            "settings": {
                "prometheus.promql": "sum ( irate ( container_cpu_usage_seconds_total { container =~ \"grafana\" } [5m] ) * 100 ) by ( pod )"
            },
            "aggregation": "max"
        },
        {
            "metric": "mem",
            "name": "MEM使用率",
            "settings": {
                "prometheus.promql": "sum ( container_memory_usage_bytes { container =~ \"grafana\", namespace = \"monitoring\" } ) by ( pod, container ) / sum ( container_spec_memory_limit_bytes { container =~ \"grafana\", namespace = \"monitoring\" } ) by ( pod, container ) * 100"
            },
            "aggregation": "max"
        }
    ],
    "thresholds": [
        {
            "metric": "alive",
            "threshold": 101,
            "operator": "<",
            "logic": "",
            "normalize": "percentage"
        }
    ],
    "multi_thresholds": [
        {
            "thresholds": [
                {
                    "metric": "alive",
                    "threshold": 101,
                    "operator": "<",
                    "logic": "",
                    "normalize": "percentage"
                },
                "severity": 1
            ]
        }
    ]
}'

返回响应

🟢200成功
application/json
Body
request_id
string 
必需
data
integer 
必需
示例
{
  "request_id": "string",
  "data": 0
}

添加官方技术人员微信

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

微信扫码交流
修改于 2024-03-15 06:55:19
上一页
树结构 - 当前空间的整棵树
下一页
卡片名称冲突校验
Built with