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

指标列表

GET
/api/v1/northstar/metric/list
最后修改时间:2024-03-15 07:49:55
返回结果不包含指标配置信息

请求参数

Query 参数
p
string 
可选
limit
string 
可选
query
string 
可选
orderby
string 
可选
name/created_at/updated_at/deleted_at
asc
string 
可选
true or false,默认false
Header 参数
Authorization
string 
必需
示例值:
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY2Nlc3NfdXVpZCI6ImFhNGUyNGQ0LTI0OTEtNGY5Ny04NjA3LWY5YjY4ZjZlNzA5YSIsImF1dGhvcml6ZWQiOnRydWUsImV4cCI6MTY1MzYzMzY4MywidXNlcl9pZGVudGl0eSI6IjEtcm9vdCJ9.sssJhBn8R3ml6rZbuWgPG2GKlTqL3k8IrI7xvP8DioE

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.flashcat.cloud/api/v1/northstar/metric/list?p&limit&query&orderby=&asc=' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY2Nlc3NfdXVpZCI6ImFhNGUyNGQ0LTI0OTEtNGY5Ny04NjA3LWY5YjY4ZjZlNzA5YSIsImF1dGhvcml6ZWQiOnRydWUsImV4cCI6MTY1MzYzMzY4MywidXNlcl9pZGVudGl0eSI6IjEtcm9vdCJ9.sssJhBn8R3ml6rZbuWgPG2GKlTqL3k8IrI7xvP8DioE'

返回响应

🟢200成功
application/json
Body
request_id
string 
必需
data
object 
必需
p
integer 
必需
limit
integer 
必需
total
integer 
必需
items
array [object {19}] 
必需
示例
{
  "request_id": "d9c08d8bb8bad6970c7ce87b4d45af40",
  "data": {
    "p": 0,
    "limit": 0,
    "total": 0,
    "items": [
      {
        "id": 49,
        "name": "history2",
        "identifier": "history2",
        "data_source_id": 204,
        "data_source_name": "zabb_history_shadow",
        "data_source_type": "mysql",
        "related_business": [],
        "settings": {
          "mysql.sql": "select count(*) from  history2",
          "mysql.table": "history2",
          "mysql.ts.column": "updated_at",
          "mysql.ts.format": "DATE",
          "mysql.window.seconds": 60
        },
        "interval": 60,
        "enable": true,
        "owners": [
          "ss"
        ],
        "created_at": 1643193144,
        "updated_at": 1651129338
      },
      {
        "id": 58,
        "name": "oracle_test",
        "identifier": "oracle_test",
        "data_source_id": 600,
        "data_source_name": "oracle.test",
        "data_source_type": "oracle",
        "related_business": [
          {
            "id": 19,
            "name": "电商业务"
          },
          {
            "id": 24,
            "name": "快猫业务"
          }
        ],
        "settings": {
          "oracle.sql": "select count(*) from TEST",
          "oracle.table": "TEST",
          "oracle.ts.column": "TS_122",
          "oracle.ts.format": "DATE",
          "oracle.window.seconds": 60
        },
        "interval": 60,
        "enable": true,
        "owners": [
          "111"
        ],
        "created_at": 1649664542,
        "updated_at": 1650597893
      },
      {
        "id": 62,
        "name": "111",
        "identifier": "northstar_5ddd98cf9a",
        "data_source_id": 0,
        "data_source_name": "多维分析",
        "data_source_type": "dimensions",
        "related_business": [],
        "settings": {
          "dimensions.filters": [
            {
              "key": "http_host",
              "name": "域名",
              "value": "api-store.gaojihealth.cn"
            }
          ],
          "dimensions.name": "host"
        },
        "interval": 60,
        "enable": true,
        "owners": [
          "222"
        ],
        "created_at": 1651136676,
        "updated_at": 1651136676
      },
      {
        "id": 63,
        "name": "多tag指标",
        "identifier": "northstar_3d7c8f06cf",
        "data_source_id": 1,
        "data_source_name": "prometheus_2",
        "data_source_type": "prometheus",
        "related_business": [
          {
            "id": 27,
            "name": "智能报警测试-勿删"
          }
        ],
        "settings": {
          "prometheus.promql": "sum(rate(http_request_duration_seconds_count[1m])) by (module)",
          "prometheus.window.seconds": 60
        },
        "interval": 60,
        "enable": true,
        "owners": [
          "test"
        ],
        "created_at": 1652145882,
        "updated_at": 1652145882
      }
    ]
  }
}

添加官方技术人员微信

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

微信扫码交流
修改于 2024-03-15 07:49:55
上一页
删除指标
下一页
指标详情
Built with