第 9 章 定义 API(Methods 和 Metrics)
要在 3scale 中定义您的 API,请导航到 [Your_API_service] > Integration > Methods & Metrics 并添加您的方法和指标。
通过指标,您可以跟踪 3scale 中 API 的使用。hits 是内置指标,它存在于每个 API 服务中,用于跟踪对您的 API 的点击。您可以通过在 Hits 指标下定义 Methods,实现对 API 使用跟踪的精细。报告方法的流量将自动增加方法和 Hits 指标的计数器。您可以为 API 的每个端点或端点和 HTTP 方法组合定义单独的方法。请参阅 Mapping rules 部分,了解如何将 API 的端点映射到此处定义的方法。
对于除点击外的 API 测量使用情况,您可以定义一个新的Metric(指标数据),并在不同的单元中报告使用情况。单元应该可以量化并应用适合您的业务目标的含义,如兆字节、CPU 时间、API 返回的元素数量等。默认情况下,点击
以外的所有指标(如 CPU 时间或 mb
)都不包含在 3scale 上,且必须使用用户配置的外部服务定期调用端点报告。
方法和指标也是打包 API 的方法和指标:每个应用程序计划都允许您为每个方法和指标定义不同的使用限值和定价规则。
您可以在分析部分查看报告到指标和方法的使用。
9.1. 手动添加方法和指标
导航到 [Your_API_name] > Integration > Methods & Metrics。
- 单击 New method。
指定参数:
- 友好名称是方法的简短描述,它显示在 3scale 管理门户的不同部分中。此名称对于服务必须是唯一的。
-
系统名称是用于通过 3scale 服务管理 API 报告使用情况的方法名称。它还必须是唯一的,且它应该仅包含字母数字字符、下划线
_
、连字符-
和正斜杠/
,没有空格。除此之外,您可以自由决定系统名称的方式,它可以与端点("/status" 完全相同,或者可以包括方法和路径("GET_/status")。 Description 字段可用于更加详细地描述方法,它是可选的。
- 最后,单击创建方法按钮。
您稍后可以更改该方法的定义。只需单击方法名称(在列中的 Method 中),更新字段并单击"更新方法"。
在更改方法和指标的系统名称或删除它们时,请非常小心!如果存在映射到方法先前系统名称的映射规则,则可能会破坏您已部署的 3scale 集成。
要创建新指标,请单击 New metric 并提供所需的参数。在指定单元时,请使用 singular noun (如 "hit"),因为它将在分析图表中自动复数。
这些新的方法和指标将在您的当前和未来的计划中可用。现在,您可以在每个计划上编辑限制和定价规则,进入 [Your_API_service] > Applications > Application Plans > [plan_you_want_to_edit]。