- 介绍
- /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
最后修改时间:2024-11-29 07:17:02
请求参数
Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token示例:
Authorization: Bearer ********************
Body 参数application/json
name
string
名称
group_id
integer
必需
enable_time
array [object {3}]
可选
enable_stime
string
开始时间
enable_etime
string
结束时间
enable_days_of_week
string
哪天生效
queries
array [object {3}]
必需
key
enum<string>
必需
枚举值:
group_idstagshosts
op
enum<string>
必需
枚举值:
==!=
values
array [oneOf]
必需
hosts 对应的 values 是机器表示
tags 对应的 values 是机器的标签
active_target_nums
integer
下发机器数量
heartbeat_max_duration
integer
心跳活跃阈值
cate
string
插件类型
content
string
采集配置
disabled
enum<integer>
是否启用
枚举值:
10
示例
{
"name": "n9e-test2",
"group_id": 1,
"enable_time": [
{
"enable_stime": "00:00",
"enable_etime": "01:00",
"enable_days_of_week": [
1
]
}
],
"queries": [
{
"key": "all_hosts",
"op": "",
"values": null
},
{
"key": "group_ids",
"op": "==",
"values": [
1
]
}
],
"component": "HTTP_Response",
"cate": "http_response",
"content": "## collect interval\n# interval = 15\n\n\n[[instances]]\ntargets = [\n \"https://www.baidu.com\"\n]\n\n## append some labels for series\n# labels = { region=\"cloud\", product=\"n9e\" }\n\n## interval = global.interval * interval_times\n# interval_times = 1\n\n## Set http_proxy (categraf uses the system wide proxy settings if it's is not set)\n# http_proxy = \"http://localhost:8888\"\n\n## Interface to use when dialing an address\n# interface = \"eth0\"\n\n## HTTP Request Method\n# method = \"GET\"\n\n## Set response_timeout (default 5 seconds)\n# response_timeout = \"5s\"\n\n## Whether to follow redirects from the server (defaults to false)\n# follow_redirects = false\n\n## Optional HTTP Basic Auth Credentials\n# username = \"username\"\n# password = \"pa$$word\"\n\n## Optional headers\n# headers = [\"Header-Key-1\", \"Header-Value-1\", \"Header-Key-2\", \"Header-Value-2\"]\n\n## Optional HTTP Request Body\n# body = '''\n# {'fake':'data'}\n# '''\n\n## Optional substring or regular expression match in body of the response(substring case sensitive).\n## When both of the following parameters are enabled, one of them can be satisfied.\n# expect_response_substring = \"ok\"\n# expect_response_regular_expression = \"green|yellow\"\n\n## Optional expected response status codes.\n## \"expect_response_status_codes\" Supports adding multiple codes by delimiter(\"|\" or \",\").\n## When both of the following parameters are enabled, one of them can be satisfied.\n# expect_response_status_code = 0\n# expect_response_status_codes = \"200|301\"\n\n## Optional TLS Config\n# use_tls = false\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 = false\n",
"disabled": 1,
"id": 49
}
示例代码
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": "n9e-test2",
"group_id": 1,
"enable_time":[
{
"enable_stime":"00:00",
"enable_etime":"01:00",
"enable_days_of_week":[1]
}
],
"queries": [
{
"key": "all_hosts",
"op": "",
"values": null
},
{
"key": "group_ids",
"op": "==",
"values": [
1
]
}
],
"component": "HTTP_Response",
"cate": "http_response",
"content": "## collect interval\n# interval = 15\n\n\n[[instances]]\ntargets = [\n \"https://www.baidu.com\"\n]\n\n## append some labels for series\n# labels = { region=\"cloud\", product=\"n9e\" }\n\n## interval = global.interval * interval_times\n# interval_times = 1\n\n## Set http_proxy (categraf uses the system wide proxy settings if it'\''s is not set)\n# http_proxy = \"http://localhost:8888\"\n\n## Interface to use when dialing an address\n# interface = \"eth0\"\n\n## HTTP Request Method\n# method = \"GET\"\n\n## Set response_timeout (default 5 seconds)\n# response_timeout = \"5s\"\n\n## Whether to follow redirects from the server (defaults to false)\n# follow_redirects = false\n\n## Optional HTTP Basic Auth Credentials\n# username = \"username\"\n# password = \"pa$$word\"\n\n## Optional headers\n# headers = [\"Header-Key-1\", \"Header-Value-1\", \"Header-Key-2\", \"Header-Value-2\"]\n\n## Optional HTTP Request Body\n# body = '\'''\'''\''\n# {'\''fake'\'':'\''data'\''}\n# '\'''\'''\''\n\n## Optional substring or regular expression match in body of the response(substring case sensitive).\n## When both of the following parameters are enabled, one of them can be satisfied.\n# expect_response_substring = \"ok\"\n# expect_response_regular_expression = \"green|yellow\"\n\n## Optional expected response status codes.\n## \"expect_response_status_codes\" Supports adding multiple codes by delimiter(\"|\" or \",\").\n## When both of the following parameters are enabled, one of them can be satisfied.\n# expect_response_status_code = 0\n# expect_response_status_codes = \"200|301\"\n\n## Optional TLS Config\n# use_tls = false\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 = false\n",
"disabled": 1,
"id": 49
}'
返回响应
🟢200成功
application/json
Body
err
string
必需
示例
{
"err": ""
}
🟢200失败

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


修改于 2024-11-29 07:17:02