- 介绍
- /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
- 通知配置-待下线
- 快捷视 图(指标)
- 变量设置
- 单点登陆
- 用户信息--待删除(与用户管理重复)
- /v1/n9e 接口
创建采集配置
开发中
POST
https://api.flashcat.cloud/api/n9e-plus/collect
最后修改时间:2025-03-13 02:56:54
请求参数
Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token示例:
Authorization: Bearer ********************
Body 参数application/json
id
integer
可选
name
string
采集规则名称
group_id
integer
业务组id
queries
array [object {3}]
筛选条件
key
string
可选
op
string
可选
values
array [oneOf]
值
enable_time
array [object {3}]
生效时间
enable_stime
string
可选
enable_etime
string
可选
enable_days_of_week
string
可选
disabled
integer
是否禁用
component
string
组件名称
component_id
integer
组件id
cate
string
插件类型
content
string
插件配置内容
version
string
版本
示例
{
"name": "Clickhouse",
"group_id": 4,
"queries": [
{
"key": "tags",
"op": "==",
"values": [
"region=bj",
"bus=a"
]
},
{
"key": "group_ids",
"op": "==",
"values": [
4
]
}
],
"enable_time": [],
"disabled": 0,
"component": "ClickHouse",
"component_id": 0,
"cate": "clickhouse",
"content": "# # collect interval\n# interval = 15\n\n# Read metrics from one or many ClickHouse servers\n[[instances]]\n ## Username for authorization on ClickHouse server\n username = \"default\"\n\n ## Password for authorization on ClickHouse server\n # password = \"\"\n\n ## HTTP(s) timeout while getting metrics values\n ## The timeout includes connection time, any redirects, and reading the\n ## response body.\n # timeout = 5\n\n ## List of servers for metrics scraping\n ## metrics scrape via HTTP(s) clickhouse interface\n ## https://clickhouse.tech/docs/en/interfaces/http/\n # servers = [\"http://127.0.0.1:8123\"]\n\n ## If \"auto_discovery\"\" is \"true\" plugin tries to connect to all servers\n ## available in the cluster with using same \"user:password\" described in\n ## \"user\" and \"password\" parameters and get this server hostname list from\n ## \"system.clusters\" table. See\n ## - https://clickhouse.tech/docs/en/operations/system_tables/#system-clusters\n ## - https://clickhouse.tech/docs/en/operations/server_settings/settings/#server_settings_remote_servers\n ## - https://clickhouse.tech/docs/en/operations/table_engines/distributed/\n ## - https://clickhouse.tech/docs/en/operations/table_engines/replication/#creating-replicated-tables\n # auto_discovery = true\n\n ## Filter cluster names in \"system.clusters\" when \"auto_discovery\" is \"true\"\n ## when this filter present then \"WHERE cluster IN (...)\" filter will apply\n ## please use only full cluster names here, regexp and glob filters is not\n ## allowed for \"/etc/clickhouse-server/config.d/remote.xml\"\n ## <yandex>\n ## <remote_servers>\n ## <my-own-cluster>\n ## <shard>\n ## <replica><host>clickhouse-ru-1.local</host><port>9000</port></replica>\n ## <replica><host>clickhouse-ru-2.local</host><port>9000</port></replica>\n ## </shard>\n ## <shard>\n ## <replica><host>clickhouse-eu-1.local</host><port>9000</port></replica>\n ## <replica><host>clickhouse-eu-2.local</host><port>9000</port></replica>\n ## </shard>\n ## </my-onw-cluster>\n ## </remote_servers>\n ##\n ## </yandex>\n ##\n ## example: cluster_include = [\"my-own-cluster\"]\n # cluster_include = []\n\n ## Filter cluster names in \"system.clusters\" when \"auto_discovery\" is\n ## \"true\" when this filter present then \"WHERE cluster NOT IN (...)\"\n ## filter will apply\n ## example: cluster_exclude = [\"my-internal-not-discovered-cluster\"]\n # cluster_exclude = []\n\n ## Optional TLS Config\n # tls_ca = \"/etc/telegraf/ca.pem\"\n # tls_cert = \"/etc/telegraf/cert.pem\"\n # tls_key = \"/etc/telegraf/key.pem\"\n ## Use TLS but skip chain & host verification\n # insecure_skip_verify = false\n\n # [[instances.metrics]]\n # mesurement = \"sessions\"\n # label_fields = [ \"status\", \"type\" ]\n # metric_fields = [ \"value\" ]\n # timeout = \"3s\"\n # request = '''\n # SELECT status, type, COUNT(*) as value FROM v$session GROUP BY status, type\n # '''\n",
"version": "7c74222a8ef9324c18bceb70d5472c27"
}
示例代码
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/n9e-plus/collect' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Clickhouse",
"group_id": 4,
"queries": [
{
"key": "tags",
"op": "==",
"values": [
"region=bj",
"bus=a"
]
},
{
"key": "group_ids",
"op": "==",
"values": [
4
]
}
],
"enable_time": [],
"disabled": 0,
"component": "ClickHouse",
"component_id": 0,
"cate": "clickhouse",
"content": "# # collect interval\n# interval = 15\n\n# Read metrics from one or many ClickHouse servers\n[[instances]]\n ## Username for authorization on ClickHouse server\n username = \"default\"\n\n ## Password for authorization on ClickHouse server\n # password = \"\"\n\n ## HTTP(s) timeout while getting metrics values\n ## The timeout includes connection time, any redirects, and reading the\n ## response body.\n # timeout = 5\n\n ## List of servers for metrics scraping\n ## metrics scrape via HTTP(s) clickhouse interface\n ## https://clickhouse.tech/docs/en/interfaces/http/\n # servers = [\"http://127.0.0.1:8123\"]\n\n ## If \"auto_discovery\"\" is \"true\" plugin tries to connect to all servers\n ## available in the cluster with using same \"user:password\" described in\n ## \"user\" and \"password\" parameters and get this server hostname list from\n ## \"system.clusters\" table. See\n ## - https://clickhouse.tech/docs/en/operations/system_tables/#system-clusters\n ## - https://clickhouse.tech/docs/en/operations/server_settings/settings/#server_settings_remote_servers\n ## - https://clickhouse.tech/docs/en/operations/table_engines/distributed/\n ## - https://clickhouse.tech/docs/en/operations/table_engines/replication/#creating-replicated-tables\n # auto_discovery = true\n\n ## Filter cluster names in \"system.clusters\" when \"auto_discovery\" is \"true\"\n ## when this filter present then \"WHERE cluster IN (...)\" filter will apply\n ## please use only full cluster names here, regexp and glob filters is not\n ## allowed for \"/etc/clickhouse-server/config.d/remote.xml\"\n ## <yandex>\n ## <remote_servers>\n ## <my-own-cluster>\n ## <shard>\n ## <replica><host>clickhouse-ru-1.local</host><port>9000</port></replica>\n ## <replica><host>clickhouse-ru-2.local</host><port>9000</port></replica>\n ## </shard>\n ## <shard>\n ## <replica><host>clickhouse-eu-1.local</host><port>9000</port></replica>\n ## <replica><host>clickhouse-eu-2.local</host><port>9000</port></replica>\n ## </shard>\n ## </my-onw-cluster>\n ## </remote_servers>\n ##\n ## </yandex>\n ##\n ## example: cluster_include = [\"my-own-cluster\"]\n # cluster_include = []\n\n ## Filter cluster names in \"system.clusters\" when \"auto_discovery\" is\n ## \"true\" when this filter present then \"WHERE cluster NOT IN (...)\"\n ## filter will apply\n ## example: cluster_exclude = [\"my-internal-not-discovered-cluster\"]\n # cluster_exclude = []\n\n ## Optional TLS Config\n # tls_ca = \"/etc/telegraf/ca.pem\"\n # tls_cert = \"/etc/telegraf/cert.pem\"\n # tls_key = \"/etc/telegraf/key.pem\"\n ## Use TLS but skip chain & host verification\n # insecure_skip_verify = false\n\n # [[instances.metrics]]\n # mesurement = \"sessions\"\n # label_fields = [ \"status\", \"type\" ]\n # metric_fields = [ \"value\" ]\n # timeout = \"3s\"\n # request = '\'''\'''\''\n # SELECT status, type, COUNT(*) as value FROM v$session GROUP BY status, type\n # '\'''\'''\''\n",
"version": "7c74222a8ef9324c18bceb70d5472c27"
}'
返回响应
🟢200成功
application/json
Body
err
string
必需
示例
{
"err": ""
}

添加官方技术人员微信
在这里,获得使用上的任何帮助,快速上手企业告警一站式响应平台FlashDuty


修改于 2025-03-13 02:56:54