Files
hertzbeat/home/docs/help/api.md
2022-02-25 22:31:38 +08:00

1.7 KiB
Raw Blame History

id, title, sidebar_label
id title sidebar_label
api 监控HTTP API HTTP API

调用HTTP API接口查看接口是否可用对其响应时间等指标进行监测

配置参数

参数名称 参数帮助描述
监控Host 被监控的对端IPV4IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。
监控名称 标识此监控的名称,名称需要保证唯一性。
端口 网站对外提供的端口http一般默认为80https一般默认为443。
相对路径 网站地址除IP端口外的后缀路径例如 www.tancloud.cn/console 网站的相对路径为 /console
请求方式 设置接口调用的请求方式GET,POST,PUT,DELETE。
启用HTTPS 是否通过HTTPS访问网站注意⚠️开启HTTPS一般默认对应端口需要改为443
用户名 接口Basic认证或Digest认证时使用的用户名
密码 接口Basic认证或Digest认证时使用的密码
Content-Type 设置携带BODY请求体数据请求时的资源类型
请求BODY 设置携带BODY请求体数据PUT POST请求方式时有效
采集间隔 监控周期性采集数据间隔时间单位秒可设置的最小间隔为10秒
是否探测 新增监控前是否先探测检查监控可用性,探测成功才会继续新增修改操作
描述备注 更多标识和描述此监控的备注信息,用户可以在这里备注信息

采集指标

指标集合summary

指标名称 指标单位 指标帮助描述
responseTime ms毫秒 网站响应时间