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