Home » 功能 » API

使用 Dotcom-Monitor API 自动化您的监控的每一个部分

通过有文档的 REST 网络 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 团队提供完整的编程控制——无需任何 UI 点击。

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 集成生成

范围

账户范围或限定特定部门

报告类型

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

数据时间窗口

原始响应最长可达最近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>结账 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": "结账 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拉取瀑布图、密码信息和时序细分,并自动附加到PagerDuty或ServiceNow事件中——缩短事件分类时间。

XRS深度解析

实时报告,满足您的精准需求

XML Reporting Service是一种灵活、免费的按需数据源。可请求摘要数据或原始响应。支持按位置、计划或成功状态过滤。仅返回您关心的字段。

报告类型
获取内容
典型用途
账户利用率
每个监控解决方案的已用和可用资源
许可和容量规划,计费核对
设备状态
单个设备或设备组的当前状态和状况
实时状态页面,NOC墙面仪表板
响应详情
高度可定制的每次请求时间和内容
详细诊断,自定义瀑布图,事件丰富化
设备和任务配置
导出的监控配置快照
备份,跨环境克隆,审计轨迹
汇总数据
正常运行时间,停机时间,成功次数,失败次数,性能,标准差
执行摘要,SLA报告
原始响应
设备的每次检查结果,最长可追溯6个月
法医分析,历史比较
小时汇总
响应数据分桶到1小时窗口
峰值负载识别,小时趋势分析
每日汇总
响应数据分桶到24小时窗口
日常运营评审,工作日与周末比较
每周 / 每月 / 每年
跨越较长时间范围的汇总
董事会层面的趋势分析,年度同比表现报告
3个月统计
在滚动3个月窗口内计算的统计数据
基线衍生的警报,异常检测

每个报告都可以按监控地点计划Dotcom-Monitor 过滤器成功或失败状态部门自定义日期范围进行筛选。

团队为何使用 API

为 DevOps、SRE 和平台工程打造

Dotcom-Monitor API 消除监控工作流程中的手动界面点击,使您的团队能够在不增加人手的情况下扩大合成覆盖范围。

消除漂移

将监控配置保存在源代码控制中。自信地在多个环境中应用相同的监控器。

左移监控

在与所覆盖服务相同的 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 内容时,请设置 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、电子邮件、FTP、ICMP Ping、TCP 端口、Traceroute、VoIP 等)。还包括完整的 LoadView 负载测试功能。

API 和 XRS 访问包含在每个付费计划中 — 无按调用计费,无附加费用。会话在 60 秒无活动后过期,这自然限制了长时间运行的脚本。如果您需要基于 IP 的访问限制或企业级吞吐量,请联系销售了解企业版选项。

XRS 可以返回过去最多 6 个月的原始响应数据。摘要和统计报告(按小时/每日/每周/每月/每年汇总及三个月统计)可在更长时间范围内提供。您可以为每个报告指定开始和结束日期/时间。

可以 —— 任何可以发出 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 让管理覆盖变得轻松。