跳转到内容
搜索文档

端点管理

最后更新 查看 MarkdownAgent 设置
Available on all plans

通过使用 API Shield 的端点管理保存、更新和监控性能指标,来监控 API 端点 的健康状况。

Add endpoints(添加端点) 允许客户直接从 API 发现 或手动按方法、路径和主机保存端点。

这会将指定的端点添加到您的托管端点列表中。您可以在 Endpoint management(端点管理) 页面中查看已保存端点的列表。

当您保存端点时,Cloudflare 将开始收集您端点的性能数据

访问

  1. 在 Cloudflare 仪表板中,前往 Web assets(Web 资产) 页面。

    Go to Web assets ↗
  2. 前往 Endpoints(端点) 选项卡。

  3. 选择 Add endpoints(添加端点)

  4. 选择手动添加、从架构验证或从API 发现添加您的端点。

  1. 登录到 Cloudflare 仪表板, 并选择您的账户和域。
  2. 选择 Security(安全性) > API Shield
  3. 选择手动添加、从架构验证或从API 发现添加您的端点。

从 API 发现添加端点

有两种方法可以从 API 发现 (API Discovery) 中添加 API 端点。

从端点选项卡添加

  1. Endpoints(端点),转到 Add endpoints(添加端点) > Select from Discovery(从 Discovery 中选择) 选项卡。
  2. 选择您要添加的已发现的端点。
  3. 选择 Add endpoints(添加端点)
  1. Endpoint management(端点管理),转到 Add endpoints(添加端点) > Select from Discovery(从 Discovery 中选择) 选项卡。
  2. 选择您要添加的已发现的端点。
  3. 选择 Add endpoints(添加端点)

从 Discovery 选项卡添加

  1. Web assets(Web 资产),前往 Discovery(发现) 选项卡。
  2. 选择您要添加的已发现的端点。
  3. 选择 Save selected endpoints(保存所选端点)
  1. 从端点管理,选择 Discovery(发现) 选项卡。
  2. 选择您要添加的已发现的端点。
  3. 选择 Save selected endpoints(保存所选端点)

从架构验证添加端点

  1. Web assets(Web 资产),前往 Endpoints(端点) 选项卡。
  2. 选择 Add endpoints(添加端点) > Upload schema(上传架构)
  3. 上传架构文件。
  4. 选择 Add schema and endpoints(添加架构和端点)
  1. 通过配置架构验证添加架构。
  2. 审查架构端点 上,勾选复选框将新端点保存到端点管理。
  3. 选择 Save as Draft(保存为草稿)保存并部署。无论架构是保存为草稿还是发布,端点都将被保存。

API Shield 将查找具有相同主机、方法和路径的重复端点。重复的端点将不会保存到端点管理。

手动添加端点

  1. Web assets(Web 资产),前往 Endpoints(端点) 选项卡。
  2. 选择 Add endpoints(添加端点) > Add manually(手动添加)
  3. 从下拉菜单中选择方法,并为端点添加路径和主机名。
  4. 选择 Add endpoints(添加端点)
  1. 从端点管理,选择 Add endpoints(添加端点) > Add manually(手动添加)
  2. 从下拉菜单中选择方法,并为端点添加路径和主机名。
  3. 选择 Add endpoints(添加端点)

手动添加端点时,您可以通过将变量字段用花括号括起来,在路径或主机中指定变量字段,例如 /api/user/{var1}/details{hostVar1}.example.com

Cloudflare 支持以下格式的主机名变量:

{hostVar1}.example.com

foo.{hostVar1}.example.com

{hostVar2}.{hostVar1}.example.com

主机名变量必须包含整个域字段,并且不得与该字段中的其他文本一起使用。

不支持以下格式:

foo-{hostVar1}.example.com

有关 Cloudflare 如何在 API Shield 中使用变量的更多信息,请参阅 API 发现中的示例。

手动删除端点

您可以逐个或批量删除端点。

  1. Web assets(Web 资产),前往 Endpoints(端点) 选项卡。
  2. 选择您要删除的端点所对应的复选框。
  3. 选择 Delete endpoints(删除端点)
  1. 从端点管理中,选择您要删除的端点所对应的复选框。
  2. 选择 Delete endpoints(删除端点)

端点分析

对于每个保存的端点,客户可以查看:

  • Request count(请求计数):端点随时间收到的请求总数。
  • Rate limiting recommendation(速率限制建议):每 10 分钟。这以请求计数为指导。
  • Latency(延迟):以毫秒 (ms) 为单位的平均源站响应时间。此指标显示从访问者发出请求到访问者收到来自源站的响应所花费的平均时间。
  • Error rate(错误率) 与总体流量对比:按 4xx、5xx 以及它们的总和分组。
  • Response size(响应大小):返回给请求的平均响应大小(以字节为单位)。
  • Labels(标签):分配给该端点的当前标签
  • 身份验证状态:在发往此端点的成功请求中看到了哪些会话标识符的明细。
  • Sequences(顺序):发现该端点所在的顺序分析顺序的数量。

使用 Cloudflare API

您可以通过 Cloudflare API 与端点管理进行交互。有关更多信息,请参阅 端点管理的 API 文档

敏感数据检测

敏感数据包含各种个人身份信息和财务数据。Cloudflare 创建了此规则集以应对常见的数据泄露威胁,并且 WAF 可以在来自您源站的 HTTP 响应正文中搜索这些数据。

如果区域还订阅了敏感数据检测托管规则集,API Shield 将在端点管理中列出的 API 端点的响应正文中存在敏感数据时向用户发出警报。

在我们的 Advanced 应用安全计划中,敏感数据检测可供企业版客户使用。

一旦为您的区域启用了敏感数据检测,API Shield 就会查询过去七天来自 WAF 的防火墙事件,如果您的端点有任何匹配的敏感响应,则会在端点管理表行上放置一个通知图标。

如果展开端点管理表行以查看更多详细信息,API Shield 将显示发现的敏感数据类型。选择 Explore Events(探索事件) 以在安全事件中查看匹配的事件。

在为您的区域启用敏感数据检测后,您可以浏览敏感数据检测规则集。如果未启用敏感数据检测,该链接将不起作用。

限制

当请求由 Cloudflare 服务以阻止其直接传递给您的源服务器的方式处理时,不支持某些性能指标(例如延迟)。

具体在以下情况下会观察到此限制:

  • Cloudflare Worker 正在 URL 路径上运行。
  • 在应用程序上激活了基于 Workers 构建的其他产品,例如 Waiting Room

在这些情况下,系统无法准确测量源站响应时间,并且该指标不会在仪表板中填充。

这篇文档对您有帮助吗?