本节帮助希望使用 Dotcom-Monitor 监控工具开发应用程序的软件开发人员。

除了 Dotcom 监视器网站界面之外,还有多种方法可以查看监控数据并与之交互,包括使用 XML 源来使用数据以及与 Dotcom 监视器 API 交互以监控和更新已安装的监控代理。

使用 XML 源,开发人员可以订阅想要的数据,并使用自己的自定义报表以自己的格式呈现数据。 有关详细信息,请参阅 使用 XML 报告服务 (XRS) 工具

Dotcom-Monitor API 用户可以创建自己的自定义脚本或应用程序,以便与设置进行交互,并在自己的自定义环境中查看监控的数据。 我们的系统使用 REST API,通过 HTTP (S) 请求(GET、POST、PUT、删除)使用最流行的数据处理方法,实现与 Dotcom-Monitor 网站的交互。 几乎所有 Dotcom 监视器对象都可以通过 REST API 访问,并且几乎可以管理 Dotcom 监视器服务功能的几乎每个方面。 使用 API 呼叫,开发人员可以创建和删除设备和任务、推迟和启动它们、创建和管理警报组、模板、过滤器和调度器、获取设备状态信息以及许多其他选项。

一般来说,Dotcom 监视器 API 可用于以下任务:

  • 第三方集成与 Dotcom 监控解决方案。
  • 数据下载和上传。
  • 数据修改。

通过 REST API 执行的最常见操作:

  • 访问监控平台、设备、目标、调度器、位置、警报组、过滤器、警报模板的列表。
  • 访问平台、设备和目标的详细信息。
  • 编辑设备、目标、调度器、警报组和模板、过滤器。
  • 创建新的网络监视器对象(设备、目标、调度器等)。
  • 管理审计对象。

自定义收集器 API

单独的 MetricsView API 是一组方法,用于将来自任何来源的任何指标(无论平台如何)上传到 Dotcom-Monitor Inc. 进行进一步处理和分析。

Dotcom-Monitor API 分为 10 种资源类型:

  • 平台:所有监视任务都属于五个不同的平台之一。
  • 设备: 监控设备是一组有组织的监控任务,其中包含单个监控任务、一系列监控任务、包含任务的监控脚本,或包含所有三个任务的组合。
  • 任务:任务是任何单一的监控活动,例如监视目标(URL、邮件服务器、FTP 服务器等)。
  • 频率:定义执行监视会话的频率。
  • 调度器: 调度器详细说明任务何时运行或将不运行。
  • 位置:Dotcom-Monitor 全球监控网络内的监控位置。
  • 警报组: 设置组将报告和/或警报的接收者放置到组中。 组中的每个收件人都可以具有唯一的警报模板。
  • 警报模板: 模板定义警报格式。
  • 过滤器: 过滤器是一组规则,它决定如何处理和显示监控响应。
  • 审计: 提供每个帐户修改的历史信息。

在任何 API 请求之前,您都需要在 Dotcom 监视器中 进行身份验证 。 身份验证将在 60 秒不活动后过期。

下表显示了每种资源类型支持的请求类型和操作。 有关详细描述,请参阅 监控方法 部分。

资源类型 请求方法 URI () 描述
平台 获取 /平台 返回可用平台列表
装置 获取 /设备/{platform} 按平台获取设备列表。
获取 /装置/{deviceId} 获取设备信息
发布 /devices?verb=PUT 创建新设备
/设备
发布 /device/{deviceId}/DisableAlert/ 禁用警报
发布 /装置/{deviceId} 编辑设备
发布 /device/{deviceId}?verb=delete 删除设备
删除 /装置/{deviceId}
任务 获取 /device/{deviceid}/tasks 获取设备下的任务列表
发布 /tasks?verb=PUT 创建新任务
/任务
获取 /任务/{TaskId} 获取任务信息
发布 /任务/{TaskId} 编辑任务
发布 /task/{TaskId}?verb=delete 删除任务
删除 /任务/{TaskId}
频率 获取 /frequencies/{platform_name} 获取可用 freq。 按平台。
调度 获取 /schedulers 获取调度程序列表
获取 /调度/{Scheduler_ID} 获取特定的计划程序信息
发布 /schedulers?verb=PUT 创建新的调度程序
调度器
发布 /scheduler/{ 调度器 ID} 编辑调度程序
发布 /scheduler/{Scheduler_Id}?verb=delete 删除调度程序
删除 /调度/{Scheduler_Id}
位置 获取 /地点/{platform_name} 获取可用位置列表
警报组 获取 /组 获取警报组列表
发布 /groups?verb=PUT/组 创建警报组
组/组
获取 /群/{Group_ID} 获取警报组信息
发布 /群/{Group_ID} 编辑警报组
发布 /group/{Group_Id}?verb=delete 删除组
删除 群/{Group_Id}
警报模板 获取 /模板 获取警报模板列表
发布 /templates?verb=PUT/模板 创建新的警报模板
/templates/模板
获取 /模板/{Template_ID} 获取警报模板信息
发布 /模板/{Template_ID} 编辑警报模板
发布 /template/{Template_Id}?verb=delete 删除模板
删除 /模板/{Template_Id}
滤波器 获取 /过滤 器 获取筛选器列表
发布 /filters?verb=PUT 创建新筛选器
/过滤 器
获取 /滤波器/{filter_ID} 获取特定筛选器信息
发布 /滤波器/{filter_ID} 编辑过滤器
发布 /filter/{filter_ID}?verb=delete 删除过滤器
删除 /滤波器/{filter_ID}
审计 获取 /audit/list (审计/列表) 获取当前用户在过去 24 小时内的审核对象列表。
获取 /audit/object/{样本 ID} 获取特定 ID 的审核内容
发布 /audit/list (审计/列表) 获取已审核对象的筛选列表。