提高 API 采用率的关键：快速创建有效的 API 监控任务

为什么需要 API 监控？

在当今数字化时代，企业应用程序及网站越来越依赖于外部 API 和第三方应用程序提供商。例如一家电商公司，他们的网站可能同时会接入多个外部 API，包括支付、物流、广告等服务。如果在用户购买商品时，恰巧出现了支付 API 故障，就会导致用户无法完成付款动作，从而影响公司的整体营收。API 的可靠性直接关系到公司的业务运转。当应用程序中的 API 出现问题时，会影响到整个网站或应用程序的性能，甚至会导致网站或应用程序直接崩溃。因此，API 监控变得至关重要。

监控宝 API 监控

监控宝提供的 API 监控能够利用全球近百个监测点，实时监控 API 的运行状况，包括可用性、正确性、响应时间等性能数据。通过实时告警和历史统计分析，帮您快速发现并解决问题，节约企业的运维成本，减少业务损失。监控宝的 API 监控能够：

• 实时监控 get、post、put、delete、head、options 六种 API 请求方式，覆盖绝大部分的接口调用格式。

• 支持 JSON、XML、Text、Response Header、状态码验证及 Postman，JMeter 脚本导入。

• 通过断言功能监测正确性，支持监控多步请求，从而实现对整个业务流程的监控。

API 监控包括可用性、正确性、响应时间、可用率、故障率、正确率、平均可用率、平均正确率、平均响应时间、错误总时长、错误总次数、故障总时长、故障总次数 13 个监控指标。判断和计算规则如下：

创建监控任务

配置入口：API 监控>任务管理

单击创建项目创建 API 监控任务，需要配置监控任务的基本信息、事务设置、监控设置和告警设置。

设置基本信息

在创建 API 监控任务页面设置监控任务的基本信息，包括定义任务名称、选择项目是否加入分类。如下图所示。

任务名称

输入任务名称，以便于查找和区分监控对象。您需要为监控任务设置一个有代表性的名称，例如您需要监控在淘宝中提交订单的业务流程，则可设置监控任务名称为“淘宝-提交订单”。

项目是否加入分类

为方便管理自己创建的监控任务，您可为当前监控任务选择一个项目分类。您还可以单击创建分类，新建一个项目分类作为当前监控任务的分类。

设置初始变量

您可利用变量来存储值，动态地提取 HTTP 响应数据，并在多个请求之间动态地传递数据和状态。比如，添加请求 1 时，可通过设置变量 $a 来动态提取 Response Header 中的 Date 值。然后在添加请求 2 时，使用变量 a 作为断言的目标值。使用变量时需要提前初始化变量，即为变量赋默认值。

在创建 API 监控任务的事务设置页面，单击设置初始化变量，添加并管理初始变量，如下图所示。

设置自定义变量

在自定义变量页面区域，单击添加变量添加一个变量，设置变量名称和变量值。自定义变量仅应用于本监控任务。注意：变量名称必须以 $符号开头，并且是纯字母组成。除自定义变量外，您可以查看系统变量及自定义系统变量，系统变量可用于所有监控任务的 API 请求。

设置系统变量

在系统变量页面区域，单击自定义页签，单击添加变量添加系统变量，定义变量名称和变量描述信息。注意：在自定义系统变量时，变量名称必须以 $public_开头。在系统变量页面区域，单击公共函数页签，查看可用的系统变量，详细说明见下表。

设置事务

在创建 API 监控任务的事务设置中添加并管理需要监控的 API 请求。

您能够直接导入脚本来添加 API 请求，也可手动添加和设置 API 请求。添加 API 请求后，可直接复制已添加的请求来创建新的请求。

通过导入脚本添加 API 请求

为快速创建多条 API 请求，单击导入脚本，在打开的对话框中直接输入脚本内容并导入。导入成功后，监控宝根据导入的脚本自动创建对应的 API 请求。在打开的导入脚本对话框，单击查看实例了解脚本样式，脚本支持 Postman 和 JMeter 格式。您可以直接使用 Postman 中生成的脚本。

手动添加 API 请求

单击添加请求，打开请求编辑页面，如下图所示。

根据实际需要设置各项内容，详细说明见下表。

复制 API 请求

为避免重复设置，添加 API 请求后，您可单击【复制按钮】复制当前 API 请求作为一条新的 API 请求，根据需要修改相应内容即可。

移动 API 请求

当添加多个 API 请求，如果需要调换请求的先后顺序，鼠标拖动目标请求移动到目标位置。

添加请求间隔

单击添加请求间隔，输入发送 API 请求的时间间隔，例如设置“10s”,则发送一次 API 请求后，等待 10s 发送第二次 API 请求。

测试 API 监控请求

添加 API 请求后，为保证正常监控，需检查是否能请求成功。单击验证测试来测试请求并查看测试结果，如下图所示。

请求成功即可用，所有请求都成功时，监控任务（即整个业务流程）的状态为正常且可用，单击展开>返回结果，查看请求的返回结果。添加断言时才能测试请求的正确性，所有请求都正确时监控任务的正确性为“是”，单击展开>变量与断言，查看断言详情。

设置监控

在创建 API 监控任务的监控设置中，设置监测点和监控频率，如下图所示。

监测点选择相应的监测点对目标 API 进行监测。您可以选择多个监测点也可以创建/选择一个监测点分组。所选择的监测点或监测点分组的成员均用来监测目标网 API。

• 选择监测点：根据需求选择多个监测点。

• 选择监测点分组：选择或创建监测点分组。若分组内监测点成员有所变化，任务创建后仍会同步。

• 注意：选择监测点分组后，监测点分组中的所有监测点都发生故障时才会向您发送告警消息。

• 监控频率：监控宝执行监控的时间间隔，例如选择 2 分钟，则监控宝每隔 2 分钟就执行一次监控。

设置告警

在创建 API 监控任务的告警设置中，设置常规告警重试次数，连续连续告警提醒，告警线，企业 IM 通知及告警方式，如下图所示。

告警设置项说明如下表所示：

小结

在过去的封闭系统中，如果出现故障，只会对该系统内的应用程序产生影响，而对于现在大部分企业来说，一个故障就会影响到整个生态系统。监控宝可以利用全球近百个监测点，实时监控 API 的运行状况，保障企业运维效率及用户体验。点击此处，马上申请监控宝免费试用名额