请打开一个支持票证,以便从您的 IP 地址访问 API。
本节帮助希望使用 Dotcom-Monitor 监控工具开发应用程序的软件开发人员。 API 支持通过简单的 HTTP/HTTPS 请求以编程方式与 Dotcom-Monitor 网站进行交互。 API 用户可以创建自己的自定义脚本或应用程序,以便与设置进行交互,并在自己的自定义环境中查看受监视的数据。 几乎可以管理 Dotcom-Monitor 服务功能的各个方面。 使用 API 调用开发人员可以创建和删除设备和任务,推迟和启动它们,创建和管理警报组筛选器和计划程序,获取状态信息以及许多其他选项。
有几种方法可以查看网站接口以外的监视数据并与之交互,包括使用 XML 馈送使用数据,并与 API 交互以监视和更新已安装的监视代理。 使用 XML 源,开发人员可以订阅想要的数据,并使用自己的自定义报表以自己的格式呈现数据。
Dotcom-Monitor API 分为 10 种资源类型:
- 平台:所有监视任务都属于五个不同的平台之一。
- 设备:受监视的设备是一个有组织的监视任务的”集”,其中包含单个监视任务、监视任务序列、包含任务的监视脚本或所有三个任务的组合。
- 任务:任务是任何单个监视活动,例如监视目标(URL、邮件服务器、FTP 服务器等)。
- 频率:定义执行监视会话的频率。
- 计划程序:计划程序详细说明任务何时将运行或不会运行。
- 位置:Dotcom-Monitor 全球监控网络内的监控位置。
- 警报组:设置组会将报表的收件人和/或警报放入组中。 组中的每个收件人都可以具有唯一的警报模板。
- 警报模板:模板定义警报格式。
- 过滤器:筛选器是一组规则,它确定如何处理和显示监视响应。
- 审核:提供有关每个帐户修改和任何帐户修改的历史信息。
下表显示了每种资源类型支持的请求类型和操作。
资源类型 | 请求方法 | URI | 描述 |
---|---|---|---|
平台 | 获取 | /平台 | 可用平台的返回列表 |
装置 | 获取 | /设备/{platform} | 按平台获取设备列表。 |
获取 | /设备/{deviceId} | 获取设备信息 | |
发布 | /设备?动词_PUT | 创建新设备 | |
把 | /设备 | ||
发布 | /设备/ {deviceId} /禁用警报/ | 禁用警报 | |
发布 | /设备/{deviceId} | 编辑设备 | |
发布 | /设备 {deviceId} /\verb_删除 | 删除设备 | |
删除 | /设备/{deviceId} | ||
任务 | 获取 | /设备 {deviceid} //任务 | 获取设备下的任务列表 |
发布 | /任务?动词_PUT | 创建新任务 | |
把 | /任务 | ||
获取 | /任务/{TaskId} | 获取任务信息 | |
发布 | /任务/{TaskId} | 编辑任务 | |
发布 | /任务 {TaskId} /\verb_删除 | 删除任务 | |
删除 | /任务/{TaskId} | ||
频率 | 获取 | /频率/{platform_name} | 获取可用 freq。 按平台。 |
调度 | 获取 | /计划程序 | 获取计划程序列表 |
获取 | /调度器/{Scheduler_ID} | 获取特定的计划程序信息 | |
发布 | /计划程序?verb_PUT | 创建新计划程序 | |
把 | 计划程序 | ||
发布 | /计划程序/* 调度程序 ID} | 编辑计划程序 | |
发布 | /计划 {Scheduler_Id} /\verb_删除 | 删除计划程序 | |
删除 | /调度器/{Scheduler_Id} | ||
位置 | 获取 | /位置/{platform_name} | 获取可用位置的列表 |
警报组 | 获取 | /组 | 获取警报组列表 |
发布 | /组?动词_PUT/组 | 创建警报组 | |
把 | 组/组 | ||
获取 | /组/{Group_ID} | 获取警报组信息 | |
发布 | /组/{Group_ID} | 编辑警报组 | |
发布 | /组 {Group_Id} /[动词]删除 | 删除组 | |
删除 | 集团/{Group_Id} | ||
警报模板 | 获取 | /模板 | 获取警报模板列表 |
发布 | /模板?动词_PUT/模板 | 创建新的警报模板 | |
把 | /模板/模板 | ||
获取 | /模板/{Template_ID} | 获取警报模板信息 | |
发布 | /模板/{Template_ID} | 编辑警报模板 | |
发布 | /模板 {Template_Id} /_verb_删除 | 删除模板 | |
删除 | /模板/{Template_Id} | ||
滤波器 | 获取 | /过滤器 | 获取筛选器列表 |
发布 | /过滤器?动词_PUT | 创建新筛选器 | |
把 | /过滤器 | ||
获取 | /过滤器/{filter_ID} | 获取特定的筛选器信息 | |
发布 | /过滤器/{filter_ID} | 编辑筛选器 | |
发布 | /过滤器 {filter_ID} /\verb_删除 | 删除筛选器 | |
删除 | /过滤器/{filter_ID} | ||
审计 | 获取 | /审核/列表 | 获取最近 24 小时当前用户的审核对象列表。 |
获取 | /审核/对象/[示例 ID] | 获取特定 ID 的审核内容 | |
发布 | /审核/列表 | 获取审核对象的筛选列表。 |