- 介绍
- /api/n9e 接口
- 告警规则
- 订阅规则
- 屏蔽规则
- 告警事件
- 通知规则
- 机器列表
- 团队管理
- 业务组管理
- 用户管理
- 权限管理
- 采集配置
- 网络设备
- 告警管理
- 指标视图
- 告警自愈
- 采集配置
- 网络设备
- 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-报警规则导出
- 数据查询
- 仪表盘
- 模板中心
- 拨测任务API
- 集成仪表盘
- 审计管理
- 数据源
- 全局屏蔽
- 仪表盘标注
- 通知媒介
- 消息模板
- auth认证
- metricsDesc
- 通知配置-待下线
- 快捷视图(指标)
- 变量设置
- 单点登陆
- 标签映射
- 事件 Pipeline
- 用户信息--待删除(与用户管理重复)
- /v1/n9e 接口
采集配置列表
GET
/api/n9e-plus/collects
最后修改时间:2024-04-09 03:46:44
请求参数
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