Flashcat API
FlashdutyNightingaleFlashcat帮助文档官网控制台
FlashdutyNightingaleFlashcat帮助文档官网控制台
  1. 采集配置
  • 介绍
  • /api/n9e 接口
    • 告警规则
      • 创建告警规则
      • 删除告警规则
      • 更新告警规则
      • 获取规则列表
      • 获取业务组下告警规则列表
      • 导入告警规则
      • 测试 relabel 配置
      • 克隆到多台机器
      • 克隆告警规则到指定业务组
      • 更新告警规则指定字段内容
      • 导入prom规则
    • 订阅规则
      • 获取订阅规则列表
      • 创建订阅规则
      • 修改订阅规则
      • 查询订阅规则
      • 删除订阅规则
    • 屏蔽规则
      • 创建屏蔽规则
      • 获取屏蔽规则
      • 修改屏蔽规则状态
      • 修改屏蔽规则详情
      • 删除屏蔽规则
    • 告警事件
      • 当前告警列表
      • 历史告警列表
      • 活跃告警-聚合规则
      • 修改告警聚合规则
      • 获取告警聚合规则
      • 删除告警聚合规则
      • 当前告警聚合信息
      • 取消认领告警
      • 告警事件通知结果
      • 认领告警
      • 事件所属的数据源列表
    • 通知规则
      • 新增通知规则
      • 修改通知规则
      • 删除通知规则
      • 通知规则列表
      • 通知规则详情
      • 通知规则配置测试
      • 自定义配置参数列表
      • 通知规则-测试事件处理
    • 机器列表
      • 获取机器列表
      • 获取机器列表-专业版
      • 绑定业务组
      • 获取标签列表
      • 绑定标签
      • 修改备注
      • 删除机器
    • 团队管理
      • 查询团队成员列表
      • 团队列表
      • 创建团队
      • 删除用户
      • 添加用户
    • 业务组管理
      • 创建业务组
      • 查询业务组列表
      • 查询业务组下团队列表
      • 修改业务组
      • 删除业务组
      • 业务组添加团队
      • 业务组删除团队
    • 用户管理
      • 创建 token
      • 获取 token 列表
      • 获取指定用户信息
      • 查询用户信息
      • 新增用户
      • 重置用户密码
      • 删除 token
      • 用户权限
      • 用户个人信息
      • 修改用户个人信息
      • 修改密码
      • 编辑用户
      • 删除用户
    • 权限管理
      • 获取角色列表
      • 获取所有操作权限点
      • 获取指定角色的权限点
      • 创建角色
      • 更新角色名
      • 更新角色权限
      • 删除角色
    • 采集配置
      • 创建测试任务
        POST
      • 查询测试任务结果
        GET
      • 创建采集配置
        POST
      • 更新采集配置
        PUT
      • 删除采集配置
        DELETE
      • 采集配置列表
        GET
      • 获取采集配置
        GET
    • 网络设备
      • 批量更新网络设备字段
      • 删除网络设备
      • 创建网络设备
      • 网络设备详情
      • 更新网络设备
      • 导入网络设备
      • 网络设备列表
      • 批量绑定标签
      • 批量解绑标签
      • 获取设备的标签
      • 获取设备的模板ids
      • 批量绑定采集模板
      • 批量解绑采集模板
      • 获取组内所有标签
      • 创建测试任务
      • 获取设备的型号
    • 告警管理
    • 指标视图
      • 获取指标查询条件
      • 查询 Metric Filter
      • 添加 Metric Filter
      • 删除 Metric Filter
      • 更新 Metric Filter
      • 导入内置指标
      • 获取内置指标
      • 更新内置指标
      • 删除内置指标
      • 获取指标类型列表
      • 获取默认指标类型
      • 获取采集器列表
    • 告警自愈
      • 创建自愈脚本
      • 获取自愈脚本列表
      • 自愈脚本详情
      • 删除自愈脚本
      • 更新自愈脚本
      • 创建自愈任务
      • 获取自愈任务列表
      • 自愈任务详情
      • 获取自愈任务脚本错误输出stderr
      • 获取自愈任务脚本输出stdout
    • 采集配置
      • 获取数据采集列表
      • 创建采集配置
      • 更新采集状态
      • 更新采集配置
      • 删除数据采集
    • 网络设备
      • 获取网络设备列表
      • 新增网络设备
      • 更新网络设备
      • 批量更新设备
      • 导入设备
      • 删除网络设备
    • pingmesh
      • pingmesh-idc网络规则注册
      • pingmesh-idc网络规则修改
      • pingmesh-idc网络规则查询
      • pingmesh-idc网络规则删除
      • pingmesh-idc间ping规则配置注册
      • pingmesh-idc间ping规则配置查看
      • pingmesh-idc间ping规则配置修改
      • pingmesh-idc间ping规则配置删除
      • pingmesh-ping动作开关设置
      • pingmesh-ping动作开关查询
      • pingmesh-idc之间拓扑图
      • pingmesh-idc内netident拓扑
      • pingmesh-netident内server之间拓扑
      • pingmesh-查询指标历史数据
      • pingmesh-idc网络规则注册(From CMDB)
      • pingmesh-报警规则导出
    • 数据查询
      • 数据批量查询接口
      • table 数据批量查询接口
      • 查询数据库名称列表
      • 查询数据库表名称列表
      • 查询数据库表结构
      • sql 查询 table
      • sql 查询 graph
      • 查询数据库名称列表 Copy
      • 查询数据库表名称列表 Copy
    • 仪表盘
      • 仪表盘列表
      • 仪表盘详情
      • 新增仪表盘
      • 删除仪表盘
      • 修改仪表盘图表
      • 克隆仪表盘到指定业务组
      • 根据 bids 获取 board名称
    • 模板中心
      • 获取内置模板类型列表
      • 更新内置模板类型
      • 创建内置模板类型
      • 删除内置模板类型
      • 获取选中模板的某类模板
      • 获取选中模板的某类模板分类
      • 获取单个模板
      • 更新内置模板
      • 创建内置模板
      • 删除内置模板
      • 根据 uuids 获取内置模版
      • 根据 uuid 获取内置payload
    • 拨测任务API
      • 创建拨测任务
      • 更新拨测任务
      • 任务禁用
      • 任务启用
      • 任务删除
      • 查询业务组下的拨测任务列表
      • 任务详情查询
    • 集成仪表盘
      • 获取集成仪表盘列表
      • 更新集成仪表盘列表
      • 获取指定集成仪表盘
      • 获取集成仪表盘列表
      • 添加集成仪表盘
      • 编辑集成仪表盘
      • 删除集成仪表盘
    • 审计管理
      • 查看审计
    • 数据源
      • cloudwatch
        • 添加数据源-cloudwatch
        • 获取 cloudwatch region 列表
        • 获取 cloudwatch namespace 列表
        • 获取 cloudwatch metric name 列表
        • 获取 cloudwatch dimension key 列表
        • 获取 cloudwatch dimension value 列表
        • 查询数据--停用,统一走query-batch
        • 创建告警规则-cloudwatch 数据源
        • 仪表盘查询数据
      • victorialogs
        • 添加数据源-victorialogs
      • 添加数据源-sqlserver
      • 数据源查询
      • 获取数据源列表
      • 新增数据源
      • 数据源类型列表
      • 更新数据源状态
      • 删除数据源
      • 数据源授权
      • 数据源删除授权
      • 数据源查看授权
    • 全局屏蔽
      • 查询全局屏蔽列表
      • 查询指定全局屏蔽
      • 新建全局屏蔽
      • 修改指定全局屏蔽
      • 删除指定全局屏蔽
      • 批量更新全局屏蔽
    • 仪表盘标注
      • 添加仪表盘注释
      • 删除仪表盘注释
      • 获取仪表盘注释列表
      • 更新仪表盘注释
    • 通知媒介
      • 新增通知媒介
      • 修改通知媒介
      • 删除通知媒介
      • 通知媒介列表
      • 通知媒介详情
      • (简化)通知媒介列表
      • flushduty 协作空间列表
      • 通知媒介详情(get by)
      • 通知媒介列表LabelKey
      • 通知媒介类别列表
    • 消息模板
      • 新增消息模板
      • 修改消息模板
      • 删除消息模板
      • 消息模板列表
      • 消息模板详情
      • 事件预览
    • auth认证
      • 度小满
        • global_sso_way
        • 获取SSO跳转地址
        • SSO登陆回调
        • sso-config
      • login登陆
      • logout登出
      • 刷新token
      • 生成图形验证码
      • 验证码验证
      • 验证码开关
      • sso-config
      • rsa-config
      • 重定向
      • sso登陆回调
      • perms
    • metricsDesc
      • metrics释义
      • 添加metricsDesc
    • 通知配置-待下线
      • 通知模板-更新
      • 通知模板-获取
      • 通知模板-新增
      • 通知设置-回调地址-获取
      • 通知设置-回调地址-更新
      • 通知设置-通知脚本-获取
      • 通知设置-通知脚本-更新
      • 通知设置-通知媒介-更新
      • 通知设置-通知媒介-获取
      • 通知设置-联系方式-更新
      • 通知设置-联系方式-获取
      • 通知设置-SMTP设置-获取
    • 快捷视图(指标)
      • 获取视图列表
    • 变量设置
      • 创建变量
      • 读取变量列表
      • 更新变量
      • 删除变量
    • 单点登陆
      • 获取单点登陆配置列表
      • 更新单点登陆
    • 标签映射
      • 词表映射列表
      • 单个标签映射详情
      • 单个标签映射数据预览
      • 创建标签映射
      • 更新标签映射
      • 删除标签词表
      • 请求测试
      • 立即触发词表更新
      • 查看更新记录
    • 事件 Pipeline
      • 事件 pipeline 列表
      • 事件 Pipeline 详情
      • 新增事件 Pipeline 规则
      • 修改事件 Pipeline 规则
      • 删除事件 Pipeline 规则
      • 事件 Pipeline 规则测试
      • 事件 processor 规则测试
    • 用户信息--待删除(与用户管理重复)
      • 添加用户
      • 修改用户
      • 删除用户
  • /v1/n9e 接口
    • 用户管理
      • 用户列表
      • 创建
      • 修改用户
      • 删除用户
    • 告警规则
      • 创建告警规则
      • 创建单个告警规则
      • 根据产品查询告警规则列表
      • 根据id查询告警规则
      • 根据id更新告警规则
      • 删除告警规则
    • 告警事件
      • 生成告警事件
      • 查看告警历史
    • 告警屏蔽
      • 创建告警屏蔽
      • 查看告警屏蔽
      • 删除告警屏蔽
      • 告警屏蔽-测试屏蔽处理
    • 主机列表
      • 获取监控对象
      • 删除监控对象
      • 获取机器元信息
      • 修改监控对象业务组
    • 智能告警
      • 查询曲线的训练效果分数
    • 接收数据
      • /opentsdb/put
    • 采集配置
      • 获取采集测试任务
      • 上报采集测试结果
    • 用户组管理
      • 获取用户组信息
  1. 采集配置

采集配置列表

GET
/api/n9e-plus/collects
最后修改时间:2024-04-09 03:46:44

接口鉴权#

参考此文档 https://flashcat.cloud/docs/content/flashcat-monitor/nightingale-v6/api/api/

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Query 参数
gids
string 
可选
示例值:
32
Body 参数application/json
dat
array[object (采集配置) {7}] 
必需
id
integer 
必需
name
string 
必需
group_id
integer 
必需
queries
array [object {3}] 
必需
disabled
integer 
必需
cate
string 
必需
content
string 
必需
err
string 
必需
示例
{
  "dat": [
    {
      "id": 0,
      "name": "string",
      "group_id": 0,
      "queries": [
        {
          "key": "string",
          "op": "string",
          "values": [
            "string"
          ]
        }
      ],
      "disabled": 0,
      "cate": "string",
      "content": "string"
    }
  ],
  "err": "string"
}

示例代码

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/n9e-plus/collects?gids=32' \
--header 'Content-Type: application/json' \
--data-raw '{
    "dat": [
        {
            "id": 0,
            "name": "string",
            "group_id": 0,
            "queries": [
                {
                    "key": "string",
                    "op": "string",
                    "values": [
                        "string"
                    ]
                }
            ],
            "disabled": 0,
            "cate": "string",
            "content": "string"
        }
    ],
    "err": "string"
}'

返回响应

🟢200成功
application/json
Body
dat
array [object {13}] 
必需
id
integer 
必需
name
string 
必需
group_id
integer 
必需
queries
array [object {3}] 
必需
disabled
integer 
必需
cate
string 
必需
content
string 
必需
version
string 
必需
create_at
integer 
必需
create_by
string 
必需
update_at
integer 
必需
update_by
string 
必需
load_by_categraf
boolean 
必需
err
string 
必需
示例
{
  "dat": [
    {
      "id": 44,
      "name": "prom",
      "group_id": 32,
      "queries": [
        {
          "key": "all_hosts",
          "op": "",
          "values": null
        },
        {
          "key": "group_ids",
          "op": "==",
          "values": [
            32
          ]
        }
      ],
      "disabled": 1,
      "cate": "prometheus",
      "content": "# # collect interval\n# interval = 15\n\n[[instances]]\nurls = [\n     \"http://localhost:19000/metrics\"\n]\n\nurl_label_key = \"{{.smtp_port}}\"\nurl_label_value = \"{{.Host}}\"\n\n## Scrape Services available in Consul Catalog\n# [instances.consul]\n#   enabled = false\n#   agent = \"http://localhost:8500\"\n#   query_interval = \"5m\"\n\n#   [[instances.consul.query]]\n#     name = \"a service name\"\n#     tag = \"a service tag\"\n#     url = 'http://{{if ne .ServiceAddress \"\"}}{{.ServiceAddress}}{{else}}{{.Address}}{{end}}:{{.ServicePort}}/{{with .ServiceMeta.metrics_path}}{{.}}{{else}}metrics{{end}}'\n#     [instances.consul.query.tags]\n#       host = \"{{.Node}}\"\n\n# bearer_token_string = \"\"\n\n# e.g. /run/secrets/kubernetes.io/serviceaccount/token\n# bearer_token_file = \"\"\n\n# # basic auth\n# username = \"\"\n# password = \"\"\n\n# headers = [\"X-From\", \"categraf\"]\n\n# # interval = global.interval * interval_times\n# interval_times = 1\n\n# labels = {}\n\n# support glob\n# ignore_metrics = [ \"go_*\" ]\n\n# support glob\n# ignore_label_keys = []\n\n# timeout for every url\n# timeout = \"3s\"\n\n## Optional TLS Config\n# use_tls = false\n# tls_min_version = \"1.2\"\n# tls_ca = \"/etc/categraf/ca.pem\"\n# tls_cert = \"/etc/categraf/cert.pem\"\n# tls_key = \"/etc/categraf/key.pem\"\n## Use TLS but skip chain & host verification\n# insecure_skip_verify = true\n",
      "version": "4b07848b2065dc50242be9f1c63291c7",
      "create_at": 1703589130,
      "create_by": "root",
      "update_at": 1703589407,
      "update_by": "root",
      "load_by_categraf": false
    },
    {
      "id": 47,
      "name": "oracle",
      "group_id": 32,
      "queries": [
        {
          "key": "all_hosts",
          "op": "",
          "values": null
        },
        {
          "key": "group_ids",
          "op": "==",
          "values": [
            32
          ]
        }
      ],
      "disabled": 0,
      "cate": "oracle",
      "content": "[[metrics]]\nmesurement = \"sessionsaaaa\"\nlabel_fields = [ \"status\", \"type\" ]\nmetric_fields = [ \"value\" ]\ntimeout = \"3s\"\nrequest = '''\nSELECT status, type, COUNT(*) as value FROM v$session GROUP BY status, type\n'''\n\n[[metrics]]\nmesurement = \"lock\"\nmetric_fields = [ \"cnt\" ]\ntimeout = \"3s\"\nrequest = '''\nSELECT COUNT(*) AS cnt\n  FROM ALL_OBJECTS A, V$LOCKED_OBJECT B, SYS.GV_$SESSION C\n WHERE A.OBJECT_ID = B.OBJECT_ID\n   AND B.PROCESS = C.PROCESS\n'''\n\n[[metrics]]\nmesurement = \"slow_queries\"\nmetric_fields = [ \"p95_time_usecs\" , \"p99_time_usecs\"]\ntimeout = \"3s\"\nrequest = '''\nselect  percentile_disc(0.95)  within group (order by elapsed_time) as p95_time_usecs, \n  percentile_disc(0.99)  within group (order by elapsed_time) as p99_time_usecs \nfrom v$sql where last_active_time >= sysdate - 5/(24*60)\n'''\n\n[[metrics]]\nmesurement = \"resource\"\nlabel_fields = [ \"resource_name\" ]\nmetric_fields = [ \"current_utilization\", \"limit_value\" ]\ntimeout = \"3s\"\nrequest = '''\nSELECT resource_name,current_utilization,CASE WHEN TRIM(limit_value) LIKE 'UNLIMITED' THEN '-1' ELSE TRIM(limit_value) END as limit_value FROM v$resource_limit\n'''\n\n[[metrics]]\nmesurement = \"asm_diskgroup\"\nlabel_fields = [ \"name\" ]\nmetric_fields = [ \"total\", \"free\" ]\ntimeout = \"3s\"\nrequest = '''\nSELECT name,total_mb*1024*1024 as total,free_mb*1024*1024 as free FROM v$asm_diskgroup_stat where exists (select 1 from v$datafile where name like '+%')\n'''\nIgnoreZeroResult = true\n\n[[metrics]]\nmesurement = \"activity\"\nmetric_fields = [ \"value\" ]\nfield_to_append = \"name\"\ntimeout = \"3s\"\nrequest = '''\nSELECT name, value FROM v$sysstat WHERE name IN ('parse count (total)', 'execute count', 'user commits', 'user rollbacks')\n'''\n\n[[metrics]]\nmesurement = \"process\"\nmetric_fields = [ \"count\" ]\ntimeout = \"3s\"\nrequest = '''\nSELECT COUNT(*) as count FROM v$process\n'''\n\n[[metrics]]\nmesurement = \"wait_time\"\nmetric_fields = [ \"value\" ]\nlabel_fields = [\"wait_class\"]\ntimeout = \"3s\"\nrequest = '''\nSELECT\n  n.wait_class as WAIT_CLASS,\n  round(m.time_waited/m.INTSIZE_CSEC,3) as VALUE\nFROM\n  v$waitclassmetric  m, v$system_wait_class n\nWHERE\n  m.wait_class_id=n.wait_class_id AND n.wait_class != 'Idle'\n'''\n\n[[metrics]]\nmesurement = \"tablespace\"\nlabel_fields = [ \"tablespace\", \"type\" ]\nmetric_fields = [ \"bytes\", \"max_bytes\", \"free\" ]\ntimeout = \"3s\"\nrequest = '''\nSELECT\n    dt.tablespace_name as tablespace,\n    dt.contents as type,\n    dt.block_size * dtum.used_space as bytes,\n    dt.block_size * dtum.tablespace_size as max_bytes,\n    dt.block_size * (dtum.tablespace_size - dtum.used_space) as free\nFROM  dba_tablespace_usage_metrics dtum, dba_tablespaces dt\nWHERE dtum.tablespace_name = dt.tablespace_name\nORDER by tablespace\n'''\n\n[[metrics]]\nmesurement = \"sysmetric\"\nmetric_fields = [ \"value\" ]\nfield_to_append = \"metric_name\"\ntimeout = \"3s\"\nrequest = '''\nselect METRIC_NAME,VALUE from v$sysmetric where group_id=2\n'''\n",
      "version": "03d66eeab814a9212336a192f98218b2",
      "create_at": 1706163831,
      "create_by": "root",
      "update_at": 1706163831,
      "update_by": "root",
      "load_by_categraf": false
    },
    {
      "id": 48,
      "name": "mysql",
      "group_id": 32,
      "queries": [
        {
          "key": "tags",
          "op": "==",
          "values": [
            "myenv=my-test"
          ]
        },
        {
          "key": "group_ids",
          "op": "==",
          "values": [
            32
          ]
        }
      ],
      "disabled": 0,
      "cate": "mysql",
      "content": "[[instances]]\naddress = \"127.0.0.2:3306\"\nusername = \"root\"\npassword = \"1234\"\n\n# # set tls=custom to enable tls\n# parameters = \"tls=false\"\n\n# extra_status_metrics = true\n# extra_innodb_metrics = false\n# gather_processlist_processes_by_state = false\n# gather_processlist_processes_by_user = false\n# gather_schema_size = true\n# gather_table_size = false\n# gather_system_table_size = false\n# gather_slave_status = true\n\n# # timeout\n# timeout_seconds = 3\n\n# # interval = global.interval * interval_times\n# interval_times = 1\n\n# important! use global unique string to specify instance\n# labels = { instance=\"n9e-10.2.3.4:3306\" }\n\n## Optional TLS Config\n# use_tls = false\n# tls_min_version = \"1.2\"\n# tls_ca = \"/etc/categraf/ca.pem\"\n# tls_cert = \"/etc/categraf/cert.pem\"\n# tls_key = \"/etc/categraf/key.pem\"\n## Use TLS but skip chain & host verification\n# insecure_skip_verify = true\n\n#[[instances.queries]]\n# mesurement = \"lock_wait\"\n# metric_fields = [ \"total\" ]\n# timeout = \"3s\"\n# request = '''\n#SELECT count(*) as total FROM information_schema.innodb_trx WHERE trx_state='LOCK WAIT'\n#'''\n\n# [[instances.queries]]\n# mesurement = \"users\"\n# metric_fields = [ \"total\" ]\n# label_fields = [ \"service\" ]\n# # field_to_append = \"\"\n# timeout = \"3s\"\n# request = '''\n# select 'n9e' as service, count(*) as total from n9e_v5.users\n# '''\n",
      "version": "c0578b5c5248b898fc6493ce92985d21",
      "create_at": 1707211959,
      "create_by": "root",
      "update_at": 1707212288,
      "update_by": "root",
      "load_by_categraf": false
    }
  ],
  "err": ""
}

添加官方技术人员微信

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

微信扫码交流
修改于 2024-04-09 03:46:44
上一页
删除采集配置
下一页
获取采集配置
Built with