Menu Close

术语表

Red Hat 3scale API Management 2.11

了解红帽 3scale API 管理中使用的术语。

摘要

本指南记录了红帽 3scale API 管理 2.11 中使用的术语。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。我们从这四个术语开始:master、slave、黑名单和白名单。由于此项工作十分艰巨,这些更改将在即将推出的几个发行版本中逐步实施。详情请查看我们的 CTO Chris Wright 信息

第 1 章 3scale 术语表

本节充当 3scale 平台中使用的常用术语表。以下是术语表条目的结构:

  • 术语术语
  • 以下一个或多个项目:

    • 术语的定义,后跟一或两个说明性句子,另请参见 指向相关术语或术语的参考。Example:

命中 :所有方法都报告到的内置指标。可以在此处添加其他顶级指标来跟踪不应增加点击数的其他使用量。另请参阅 第 1.14.4 节 “指标”

在这种情况下,命中指标 相关,因为 hit 是一个内置指标。

  • 请参阅 指向该术语的首选同义词或简称术语的拼写输出版本的参考。Example:

帐户 :请参阅 第 1.21.1 节 “租户帐户”第 1.5.2 节 “开发人员帐户”

在这种情况下,读取器会从 帐户 重定向到包含限定符的相关术语。

  • 如果术语中有多个定义,每个项目都会编号。

1.1. 特殊字符

1.1.1. [Your_admin_domain]

用户创建的 admin 域.

1.1.2. [Your_API_name]

用户创建的 API。另请参阅 第 1.2.22 节 “应用程序编程接口”

1.1.3. [Your_API_service]

请参阅 第 1.1.2 节 “[Your_API_name]”

1.1.4. [Your_product_name]

产品由用户创建.另请参阅 第 1.17.3 节 “产品”

1.1.5. 3scale API 文档

基于 Open API 规范(OAS),这是记录来自红帽 3scale API 管理的 REST API 的 3scale 规范。另请参阅 第 1.2.2 节 “ActiveDocs”第 1.16.2 节 “OpenAPI 规格”

1.1.6. 3scale 后端

3scale API Manager 以及系统的一部分。

1.2. 一个

1.2.1. 帐户

请参阅 第 1.21.1 节 “租户帐户”第 1.5.2 节 “开发人员帐户”

1.2.2. ActiveDocs

基于 Open API 规范(OAS),这是一种 3scale 规范,用于记录用户创建的 REST API。API 获取交互式文档,使开发人员能够更加轻松地了解 API 并无需安装即可对其进行测试。另请参阅 第 1.1.5 节 “3scale API 文档”第 1.16.2 节 “OpenAPI 规格”

1.2.3. 访问令牌

允许用户通过 HTTP Basic Auth 对帐户管理 API、分析 API 和计费 API 进行身份验证的个人令牌。用户可以创建具有自定义范围和权限的多个访问令牌。另请参阅 第 1.1.5 节 “3scale API 文档”第 1.20.2 节 “服务令牌”

1.2.4. 管理员门户

API 提供商管理其产品并确保对其产品的访问权限的核心门户。通过此门户,API 提供程序可以通过 3scale 来配置产品集成,管理其应用计划,允许内部成员和外部客户访问,根据应用密钥限制流量,并自定义其开发人员门户。另请参阅 第 1.5.3 节 “开发人员门户”第 1.17.3 节 “产品”

1.2.5. 管理门户

请参阅 第 1.2.4 节 “管理员门户”

1.2.6. API

请参阅 第 1.2.22 节 “应用程序编程接口”

1.2.7. apisonator

请参阅 第 1.1.6 节 “3scale 后端”

1.2.8. API 后端

实施主机上部署的 API。另请参阅 第 1.2.22 节 “应用程序编程接口”第 1.3.1 节 “backend”

1.2.9. API 使用者

访问由 API 提供商管理的 API 或产品的个人、组或公司。该术语可以指组织为使用 API 而编写的软件应用。给定的组织可能具有一个或多个访问 API 的应用。另请参阅 第 1.2.12 节 “API 供应商”

1.2.10. API 凭证

请参阅 第 1.2.13 节 “API 密钥”第 1.22.1 节 “用户密钥”

1.2.11. API 端点

请参阅 第 1.2.22 节 “应用程序编程接口”第 1.14.3 节 “方法”

1.2.12. API 供应商

拥有 API 和产品,并使用红帽 3scale API 管理提供访问它们的实体。API 提供程序可能会使其 API 可供其组织内部的其他团队访问,也可能被第三方开发人员、合作伙伴或公众访问。它可能包含一个或多个租户。另请参阅 第 1.2.9 节 “API 使用者”第 1.21.1 节 “租户帐户”

1.2.13. API 密钥

应用的凭证类型,允许对特定的 API 或产品发出调用。API 键是特定类型的身份验证模式。另请参阅 第 1.2.22 节 “应用程序编程接口”

1.2.14. API Manager

请参阅 第 1.2.4 节 “管理员门户”

1.2.15. API 方法

请参阅 第 1.14.3 节 “方法”

1.2.16. API 产品

请参阅 第 1.17.3 节 “产品”

1.2.17. APIcast

基于 NGINX 的 API 网关,用于将内部和外部 API 与红帽 3scale API 管理集成。APIcast 是处理 API 请求的接口,可以根据其配置来处理访问控制、速率限制、安全过滤、日志记录、路由、缓存等。另请参阅 第 1.2.22 节 “应用程序编程接口”第 1.17.3 节 “产品”

1.2.18. APIcast 网关

请参阅 第 1.2.17 节 “APIcast”

1.2.19. 应用程序标识符

使用应用标识符的身份验证方法.另请参阅 第 1.2.20 节 “应用程序密钥”

1.2.20. 应用程序密钥

使用应用密钥进行身份验证方法.另请参阅 第 1.2.19 节 “应用程序标识符”

1.2.21. 应用

种软件代码,用于执行某些逻辑。该应用通常会在 3scale 系统中关联有 API 的唯一凭据集合,即发送到 API 的调用的流量历史记录,以及在创建应用时捕获的元数据。应用链接到开发人员帐户。请参阅 第 1.2.9 节 “API 使用者”。另请参阅 第 1.5.2 节 “开发人员帐户”

1.2.22. 应用程序编程接口

  1. 个软件组件的接口,可以使用基于标准的技术在通信网络上快速调用。
  2. 编程库提供的逻辑流程、功能和方法捆绑包,作为抽象层,供其他计算机程序使用。

另请参阅 第 1.1.2 节 “[Your_API_name]”第 1.2.17 节 “APIcast”第 1.2.13 节 “API 密钥”第 1.3.1 节 “backend”第 1.6.1 节 “endpoint”第 1.6.2 节 “最终用户”第 1.14.3 节 “方法”第 1.17.3 节 “产品”第 1.20.1 节 “service”

1.2.23. 身份验证

验证请求访问 API 或产品的用户或服务器的身份的过程。

1.3. B

1.3.1. backend

  1. 在 API 作为产品的情况下,将一个或多个 API 捆绑在产品中。另请参阅 第 1.3.2 节 “基本 URL”第 1.17.3 节 “产品”
  2. 作为 API,请参阅 第 1.2.8 节 “API 后端”
  3. 作为 3scale 组件,请参阅 第 1.1.6 节 “3scale 后端”

1.3.2. 基本 URL

  1. 在 API 作为产品上下文中,后端中定义的专用端点。另请参阅 第 1.3.1 节 “backend”第 1.6.1 节 “endpoint”
  2. API 网关的 Integration Settings 中定义的 URL 地址。这些地址是暂存公共基础 URL 和生产公共基础 URL。

1.4. C

1.4.1. 客户端

请参阅 第 1.2.9 节 “API 使用者”

1.4.2. CMS

请参阅 第 1.5.3 节 “开发人员门户”

1.5. D

1.5.1. 已弃用

与某一实体(如功能或受支持的配置)相关,该配置受到支持,但不再推荐,并且可能变得过时。另请参阅 第 1.19.1 节 “删除”

1.5.2. 开发人员帐户

  1. 在 3scale Hosted 中,API 提供程序认为的所有帐户都是 developer 帐户。
  2. 在 3scale 内部部署中,租户管理门户中的帐户被视为开发人员帐户。另请参阅 第 1.2.21 节 “应用”第 1.21.1 节 “租户帐户”

1.5.3. 开发人员门户

开发人员可订阅 API 的网站。在此网站上,开发人员可以管理其订阅、访问其 API、创建应用程序、访问交互式 API 文档、3scale API 文档、查看其 API 使用情况等。另请参阅 第 1.2.4 节 “管理员门户”

1.5.4. 已停用

请参阅 第 1.19.1 节 “删除”

1.6. E

1.6.1. endpoint

通信渠道的一端.当 API 与其他系统交互时,此通信的触点被视为端点。另请参阅 第 1.2.22 节 “应用程序编程接口”第 1.3.2 节 “基本 URL”第 1.14.2 节 “映射规则”第 1.14.3 节 “方法”

1.6.2. 最终用户

调用一个或多个产品和 API 的应用用户。另请参阅 第 1.2.22 节 “应用程序编程接口”第 1.17.3 节 “产品”

1.7. F

1.7.1. 字段定义

创建新用户、应用程序或帐户时显示的字段。

1.8. G

1.9. H

1.9.1. hit

所有方法都报告到的内置指标。可以在此处添加其他顶级指标来跟踪不应增加点击数的其他使用量。另请参阅 第 1.14.4 节 “指标”

1.9.2. 主机 URL

请参阅 第 1.3.2 节 “基本 URL”

1.10. I

1.10.1. 集成错误

当使用不正确的凭据集、不正确的 ID、URL 地址等执行调用时,3scale 生成的错误消息。这些消息可能是来自调用 API 的应用的错误,也可以是与 API 集成 3scale 的配置错误。

1.11. J

1.12. K

1.13. L

1.14. M

1.14.1. 管理门户

请参阅 第 1.2.4 节 “管理员门户”

1.14.2. 映射规则

将来自特定端点的传入调用关联到 3scale 中创建的对应方法和指标的规则。使用跟踪、端点访问和限值均基于配置了映射规则的方法和指标。另请参阅 第 1.6.1 节 “endpoint”第 1.14.3 节 “方法”第 1.14.4 节 “指标”

1.14.3. 方法

允许的交互 - 如 GET、POST 或 DELETE- 和 API 或产品.方法用于在 3scale 中跟踪产品和 API 的使用情况。可以为 API 的 API 端点上可用的各个 HTTP 方法添加一个方法。默认情况下,在 3scale 上,方法调用会触发内置的 hits 指标。另请参阅 第 1.2.22 节 “应用程序编程接口”第 1.6.1 节 “endpoint”第 1.14.2 节 “映射规则”第 1.14.4 节 “指标”

1.14.4. 指标

跟踪对 API 的特定调用。此跟踪通过将调用映射到集成页面的映射规则部分中的一个或多个 URL 模式来完成。指标是累计的,不是离散的。3scale 上的内置顶级指标是 Hits。如果需要,可以添加额外的顶级指标,并对它们单独考虑。另请参阅 第 1.9.1 节 “hit”第 1.14.2 节 “映射规则”第 1.14.3 节 “方法”

1.15. N

1.16. O

1.16.1. OAS

请查看 第 1.16.2 节 “OpenAPI 规格”

1.16.2. OpenAPI 规格

个标准的 RESTful API 语言中立接口,允许用户和计算机发现和了解服务的功能,而无需访问源代码、文档或通过网络流量检查。另请参阅 第 1.1.5 节 “3scale API 文档”第 1.2.2 节 “ActiveDocs”

1.17. P

1.17.1. 计划

授予对特定 API 和端点访问权限、限制流量和货币化 API 使用的方法。3scale 有不同类型的计划,可以独立或结合使用,如应用程序计划和帐户计划。

1.17.2. 潜在的升级

触发流量限制警报的开发人员帐户。这些开发人员帐户可能会升级为满足其流量卷需求的计划。

1.17.3. 产品

一个或多个 API 后端的捆绑包。另请参阅 第 1.1.4 节 “[Your_product_name]”第 1.2.4 节 “管理员门户”第 1.2.17 节 “APIcast”第 1.2.22 节 “应用程序编程接口”第 1.3.1 节 “backend”第 1.6.2 节 “最终用户”

1.18. Q

1.19. R

1.19.1. 删除

与产品中不可用且不再受支持的实体相关联,如功能或受支持的配置。另请参阅 第 1.5.1 节 “已弃用”

1.20. S

1.20.1. service

请参阅 第 1.2.22 节 “应用程序编程接口”

1.20.2. 服务令牌

用于通过服务管理 API 进行身份验证的密钥。这些密钥是自动生成的,每个服务都是唯一的,并在帐户的用户之间共享。使用 3scale API 文档中的服务令牌。另请参阅 第 1.2.3 节 “访问令牌”

1.21. T

1.21.1. 租户帐户

在 3scale 内部,主管理门户将帐户视为租户帐户。另请参阅 第 1.2.12 节 “API 供应商”第 1.5.2 节 “开发人员帐户”

1.22. U

1.22.1. 用户密钥

请参阅 第 1.2.20 节 “应用程序密钥”

1.23. V

1.24. W

1.25. X

1.26. Y

1.26.1. 您的域

请参阅 第 1.1.1 节 “[Your_admin_domain]”

1.27. Z