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

新增/修改 指标

POST
/api/v1/northstar/metric/upsert
最后修改时间:2024-03-15 07:46:32
settings选项与数据源有关,与数据源配置相关

请求参数

Header 参数
Content-Type
string 
可选
示例值:
application/json
FC-WORKSPACE-ID
string 
必需
示例值:
823147571215
Body 参数application/json
id
integer 
必需
name
string 
必需
data_source_type
string 
数据源类型
必需
data_source_id
integer 
数据源ID
必需
settings
object 
必需
description
string 
指标备注
必需
is_test
boolean 
是否测试
必需
owners
array[string]
必需
enable
string 
必需
示例
{
  "id": 1,
  "name": "一个Mysql指标",
  "uniq_key": "order_sum",
  "datasource_id": 1,
  "datasource_type": "mysql",
  "settings": {
    "mysql.ts.column": "created_at",
    "mysql.ts.format": "date",
    "mysql.window.senconds": 60,
    "mysql.sql": "select * from order_list"
  }
}

示例代码

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/v1/northstar/metric/upsert' \
--header 'FC-WORKSPACE-ID: 823147571215' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id":1,
    "name":"一个Mysql指标",
    "uniq_key":"order_sum",
    "datasource_id": 1,
    "datasource_type": "mysql",
    "settings":{
        "mysql.ts.column":"created_at",
        "mysql.ts.format":"date",
        "mysql.window.senconds":60,
        "mysql.sql":"select * from order_list"
    }
}'

返回响应

🟢200成功
application/json
Body
data
object 
可选
id
integer 
指标ID
必需
示例
{
  "data": 1
}

添加官方技术人员微信

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

微信扫码交流
修改于 2024-03-15 07:46:32
上一页
删除业务线
下一页
禁用指标
Built with