Home » 功能 » 监控 API

Dotcom-Monitor API 自动化您的监控每个环节

使用文档化的 REST Web API 和 XML 报告服务(XRS)以编程方式创建监控器,管理设备和任务,协调负载测试,并将实时性能数据流式传输到您自己的仪表盘、SIEM 和 CI/CD 流水线。
Three floating dark-mode cards on a deep navy background — a Web API JSON request creating a new HTTPS monitor, an XRS XML response with a timing breakdown, and a live API-surface KPI panel showing requests, devices, locations, sessions, and last deploy.
10,000+

全球组织

99.99%

平台正常运行时间 SLA

30+

全球监控地点

自 1998 年起

网站监控领导者

程序化监控

什么是Dotcom-Monitor API?

Dotcom-Monitor平台完全支持脚本化。您可以在网页界面中完成的任何操作——从启动新的HTTP监控到拉取三个月的性能报告——都可以通过两项互补服务程序化完成:用于配置的基于REST的Web API和用于实时数据提取的XML报告服务(XRS)

Web API是一个结构化的基于JSON的HTTP接口,向您的系统开放监控和负载测试操作。使用它可以在每次部署时配置新的监控设备,批量管理数千个基于代码配置的设备,将监控集成到现有的工单工具,或将实时性能数据嵌入面向客户的状态页面。

XML报告服务(XRS)是一项免费的按需数据接口,返回XML格式的监控结果。您可以将其指向任何报告仪表盘、BI工具、Excel工作簿或内部数据库,实现自定义视图而无需等待工程支持。

两者联合为您的平台、SRE和DevOps团队提供完整的程序化控制——无需任何界面点击操作。

Web API — 快速参考

https://api.dotcom-monitor.com/config_api_v1/

格式

JSON请求 / JSON响应

方法

GET(读取)· POST / PUT(写入 / 更新)

认证

每请求60秒会话;可选IP白名单

传输

HTTP或HTTPS

XRS — 快速参考

https://xmlreporter.dotcom-monitor.com/reporting/xml/

格式

通过HTTP(S) GET返回XML响应

认证

账户 UID (PID) 在 管理 > 集成 中生成

数据深度

最多可追溯6个月的原始响应

费用

免费,包含于每个账户中

1

生成密钥

在您的账户中创建 Web API 或 XML Feed 集成。

2

配置

发送 POST JSON 来创建设备、任务、组、计划和警报。
3

监控

在您定义的计划上,从30多个全球位置执行运行。
4

提取

通过 XRS 将结果拉取到仪表板、BI、Excel 或内部应用中。
核心 API 功能

界面能做的一切 — 以代码方式实现

您的账户中的每个监控对象都是一等的 API 资源。可单独或批量管理它们,跨环境操作。

完整监控配置

设备、任务及组管理

位置与计划

告警及通知集成

XRS 实时报告推送

工作原理

四步实现从零到自动监控

无需安装 SDK。如果您的系统能够发出 HTTP 请求,就可以与 Dotcom-Monitor 通信。

01

创建集成

在您的 Dotcom-Monitor 账户中,转到 管理 > 集成 并创建新的 Web API 集成(用于配置)或 XML Feed 集成(用于报告)。可选地按 IP 地址限制访问。

02

身份验证

每个请求都会对您的集成进行身份验证。会话在 60 秒无活动后过期,确保访问时间短且安全。XRS 请求使用您生成的账户 UID(PID)。

03

发送 JSON 请求

调用 GET 进行读取,调用 POST/PUT 进行写入。发送主体时设置 Content-Type: application/json。错误会返回结构化 JSON。

04

全面自动化

将 API 接入 Terraform、Jenkins、GitHub Actions、Azure DevOps 或您自己的脚本。部署时触发监控配置,将性能数据拉入 BI,或在 SLA 违规时自动报警。

技术规格

两个 API。一 个账户。完全控制。

Web API 负责配置;XRS 负责报告。它们共享单一身份验证模型,适用于所有 Dotcom-Monitor 解决方案。

Web API(配置与控制)

以编程方式管理您的监控基础设施。

基础 URL

api.dotcom-monitor.com/config_api_v1/

协议

HTTP,HTTPS

请求格式

JSON (application/json)

响应格式

JSON

方法

GET (读取) · POST, PUT (写入 / 更新)

认证

Web API 集成密钥,每次请求会话(60秒超时)

访问控制

IP 白名单可选

覆盖范围

监控 + LoadView 方法

管理对象

设备、任务、组、计划、过滤器、警报、位置、负载测试、用户

错误处理

带错误代码和消息的结构化 JSON

XML 报告服务 (XRS)

将实时监控数据流传输到任何支持 XML 的系统。

基础 URL

xmlreporter.dotcom-monitor.com/reporting/xml/

协议

HTTP,HTTPS

请求格式

带有URL参数的HTTP(S) GET请求

响应格式

XML文档

认证

账户UID(PID),作为XML Feed集成生成

范围

账户范围内或限定于特定部门

报告类型

设备配置、状态、原始响应、汇总(小时/天/周/月/年)、3个月统计

数据窗口

原始响应最多可达最近6个月

筛选条件

位置、计划、设备、成功/失败、部门、日期范围

输出目标

仪表板、SQL、Excel、Power BI、自定义应用

开发者友好

简单的HTTP。
无需SDK。

每个监控对象——设备、任务、警报、组、计划——都表示为JSON资源。以下是从XRS拉取监控数据并通过Web API推送新设备的示例。将这些命令放入curl、bash脚本、Python任务或CI步骤——适用于您团队已使用的任何环境。

返回字段包括:DnsTimeSSLTimeConnectionTimeRequestTimeFirstPacketTime (TTFB)DownloadTimeDuration,加上位置、状态和监控时间戳——即可直接应用于任何瀑布图视图。

# 拉取实时XRS报告——按位置汇总
GET https://xmlreporter.dotcom-monitor.com/reporting/xml/responses.aspx
     ?PID=4229AF4F0FB545AEA75EAF2013E51BB7
     &Site=12345
     &Type=Overall
     &location=NY, USA

# 响应(已裁剪)
<Response>
  <ID>3424533543</ID>
  <Name>Checkout API</Name>
  <URL>https://shop.example.com/api/checkout</URL>
  <Duration>114</Duration>
  <DnsTime>0</DnsTime>
  <SSLTime>18</SSLTime>
  <ConnectionTime>15</ConnectionTime>
  <FirstPacketTime>97</FirstPacketTime>
  <DownloadTime>2</DownloadTime>
  <Status>S</Status>
</Response>

# 通过Web API创建新的HTTPS监控
POST https://api.dotcom-monitor.com/config_api_v1/devices
Content-Type: application/json

{
  "name": "Checkout API — 生产环境",
  "platform": "HTTPS",
  "tasks": [{
    "url": "https://shop.example.com/api/checkout",
    "method": "POST",
    "keyword": "order_id"
  }],
  "frequency": 60,
  "locations": ["NY-USA", "FR-PARIS", "SG"]
}

5分钟内开始自动化您的监控

所有付费套餐均包含完整的Web API和XRS访问权限——无附加组件,无调用计费,无额外计费等级。

使用案例

团队使用API构建的内容

平台团队、SRE和DevOps工程师使用Dotcom-Monitor API将监控集成到他们现有的工作流程中。

代码即监控

为每个监控和其保护的服务进行版本管理。通过您现有的Terraform或Pulumi管道配置、更新和停用设备——避免预生产和生产环境之间的漂移。

部署后冒烟测试

在每次部署后,从Jenkins、GitHub Actions或Azure DevOps触发按需HTTPS和多步骤事务检查。当新版本导致关键端点故障时,构建失败。

自定义状态页面和仪表盘

将XRS数据传输到面向客户的运行时间页面、内部NOC显示或高管SLA报告。仅提取您需要的字段,格式完全符合您的需求。

SLA证据与合规报告

自动将月度SLA导出(运行时间百分比、P95 / P99响应时间、停机事件)直接从XRS导出到Excel或PDF——文档化、时间戳记录且可审计。

批量设备配置

在收购、迁移或CDN切换后,一次性快速部署数百个监控。克隆现有设备模板并大规模分配正确的组、计划和警报路线。

第三方仪表盘嵌入

将监控数据与其他遥测数据一同传输到Grafana、Power BI、Tableau或Datadog——外部合成检查与内部APM跟踪相关联。

多租户账户管理

MSP和企业团队可以通过单次程序化操作管理数百个部门和数千台设备,为每个客户提供部门范围的XRS数据流。

事件丰富

当监视器触发时,通过 XRS 自动提取 waterfall、cipher 和时序细节,并附加到 PagerDuty 或 ServiceNow 事件中——减少初步诊断时间。

XRS 深度解析

实时报告,正如您所需

XML 报告服务是一个灵活、免费的按需数据源。可请求概要数据或原始响应。可按地点、计划或成功状态过滤。仅返回您关心的字段。

报告类型
您获得的内容
典型用途
账户使用率
各监控解决方案的已用与可用资源
许可证与容量规划,计费对账
设备状态
单个设备或设备组的当前状态与状况
实时状态页面,NOC 大屏仪表盘
响应详情
每次请求的时间与内容高度可定制
详细诊断,自定义 waterfall,事件丰富
设备与任务配置
导出的监控配置快照
备份、跨环境克隆、审计日志
概要数据
上线时间、宕机时间、成功次数、失败次数、性能、标准差
管理摘要、SLA 报告
原始响应
设备的每次检查结果,最长可追溯 6 个月
法医分析,历史对比
每小时汇总
响应数据按1小时窗口分组
峰值负载识别,小时趋势分析
每日汇总
响应数据按24小时窗口分组
每日操作审查,工作日与周末比较
每周 / 每月 / 每年
跨更长时间范围的汇总
董事会层面趋势分析,年比年绩效报告
3个月统计
滚动3个月窗口计算的统计数据
基线派生警报,异常检测

每个报告都可以按监控位置时间表Dotcom-Monitor筛选成功或失败状态部门,以及自定义日期范围进行过滤。

团队为何使用API

为DevOps、SRE和平台工程打造

Dotcom-Monitor API消除监控工作流程中的手动UI点击,让您的团队无需增加人手即可扩展合成监测覆盖。

消除漂移

将监控配置保持在源代码控制中。在不同环境中自信地应用相同监控。

向左转移监控

在与所覆盖服务相同的PR中添加合成检查。监控随代码同步上线,而非延迟数周。

无点击扩展

用单个脚本入驻上百个新域或上千个新端点。无需点击疲劳。

细粒度安全

短期会话,可选的IP白名单,以及部门范围的集成密钥确保访问严格。

适合任何技术栈

纯HTTP + JSON(或用于报告的GET + XML)。无SDK锁定。兼容所有语言和CI/CD工具。

掌控您的数据

按您的时间表将监控数据拉取到您自己的数据仓库、BI平台或合规档案中。

统一界面

一个API覆盖监控和LoadView负载测试——无需单独工具,无需单独凭证。

无额外费用

每个付费计划均包含API和XRS访问。无调用计费,无自动化额外收费。

客户评价

“Dotcom最棒的功能之一就是其推送/拉取API功能,为我们提供网络性能数据。我们用它来监控性能问题以及页面加载统计。Dotcom-Monitor允许我们在一个界面和平台内监控多个服务,使我们的运营更加高效。”
Gregory S.
经理,广播媒体 · Capterra认证评价

准备让您的监控自动化运行了吗?

每个30天试用包含完整的Web API和XRS访问权限——覆盖所有监控解决方案、所有位置及所有集成。体验自动化监控的感受。

常见问题

关于Dotcom-Monitor API的常见问题

Web APIconfig_api_v1)是一个基于 JSON 的 REST 接口,用于创建和管理监控配置——设备、任务、组、计划、告警和负载测试。XML 报告服务(XRS)是一个独立的免费数据源,通过 HTTP GET 返回监控结果的 XML。大多数团队都同时使用:Web API 用于配置,XRS 用于提取结果。

在您的 Dotcom-Monitor 账户中,进入 管理 > 集成 > 新建集成,创建一个 Web API 集成(用于配置)或 XML Feed 集成(用于 XRS)。每个 Web API 请求都会针对该集成进行认证,且会话在 60 秒无活动后过期。XRS 使用生成的账户 UID 作为PID URL 参数。您还可以通过 IP 地址限制访问权限。

Web API 完全基于 JSON——请求体和响应均是 JSON。发送 JSON 数据时请设置 Content-Type: application/json。XRS 则通过 HTTP(S) GET 返回 XML 文档,请求只需包含带参数的 URL。

Web API 覆盖所有 Dotcom-Monitor 监控平台:HTTPS、REST、SOAP、GraphQL、WebSocket、ServerView、BrowserView、UserView(EveryStep 脚本)以及 MetricsView,还包括所有协议监控(DNS、SSL、Email、FTP、ICMP Ping、TCP 端口、Traceroute、VoIP 等)。它还覆盖了完整的 LoadView 负载测试功能。

API 和 XRS 访问包含在所有付费方案中——无调用次数计量且无额外费用。会话在 60 秒无活动后过期,自动限制长时间运行的脚本。如需 IP 限制访问或企业级吞吐量,请联系销售了解企业方案。

XRS 可以返回最多过去 6 个月的原始响应数据。汇总和统计报告(按小时/天/周/月/年聚合以及 3 个月统计)支持更长时间范围。每份报告可指定起止日期/时间。

可以——任何能发起 HTTP 调用的工具都能驱动 API。团队常见集成 Jenkins、GitHub Actions、GitLab CI、Azure DevOps、CircleCI 和 Terraform,在部署时自动配置监控,发布后跑冒烟测试,并根据监控健康状况控制生产发布。

可以。创建 Web API 集成时,您可以允许所有通过认证的请求访问,也可以限制为来自可信 IP 地址列表的访问。详情请参见知识库中《如何为 Web API 访问设置 IP 白名单》一文。

支持。根账号上的用户可通过程序管理部门,XML Feed 集成可限定范围至特定部门。部门限制用户只能拉取自身部门的 XRS 报告,支持 MSP 和多租户环境的清晰隔离。

完整文档位于 Dotcom-Monitor 知识库,包括API 入门指南、带 JSON 示例的监控与 LoadView 方法参考,以及XRS 请求参数参考。代码示例栏目提供了现成的代码模板。

自动化监控。抢回工程时间。

超过10,000个机构使用 Dotcom-Monitor,在客户发现故障之前捕获问题——并通过 API 和 XRS 让管理监控变得轻松。