术语库

本页面适用于 ApigeeApigee Hybrid

查看 Apigee Edge 文档。

以下概念是 Apigee 中具有独特意义的常见概念。

A

API 基本路径和资源
API 由基本路径和一组资源(也称为资源路径)组成。为每个 API 定义单个根网址(也称为基本路径和多个资源路径)。您可以将 API 简单地视为一组 URI,所有 URI 共用一个基本路径。为了让您更轻松地管理 API,Apigee 使用显示名和描述来增强这些原始 URI。
API 使用方
应用开发者同义词,使用 API 提供方创建的 API。
API 开发者
构建 API 的 API 提供方组织中的软件工程师。应用开发者(API 使用方)使用这些 API 构建应用。
API 产品
与服务计划组合并以软件包形式提供给开发者的 API 资源 (URI) 集合。API 产品还可以包含特定于您的业务的元数据,用于进行监控或分析。您可以通过将一个或多个资源加入 API 产品来获利,然后可将这些资源绑定到 API 软件包中用于获利。
API 提供方
API 提供方构建 API(使用 Apigee)供 API 使用者(应用开发者)使用。
API 代理
充当现有 API Facade 的代理。开发者不会调用现有 API,而是开始调用 Apigee 生成的新 API。这种 Facade 会使您的公共接口与后端 API 分离,从而保护开发者免受后端更改的影响,同时可让您在边缘进行创新,而不会影响内部开发团队。当您更改后端时,开发者会继续调用相同的 API,而不会中断。在更高级的场景中,Apigee 允许您向同一 API 中公开多个接口,从而免去自定义 API 的签名,以满足不同开发者群体的需求。
Apigee API
可用于配置环境、组织、API 代理和其他混合服务的端点。
应用开发者
应用开发者向 API 提供方注册他们的应用,同时应用开发者需要获取调用提供方 API 代理所需的 API 密钥。
应用
开发者使用应用来访问 API 产品中的资源。在创建应用时,您可选择要添加的 API 产品,Apigee 会生成密钥。每个应用都有一个单独密钥,可让您访问多个 API 产品。通过应用,您可以控制哪些用户可以访问您的资源。您可以通过撤消和刷新应用密钥来控制谁有权访问您的 API 产品。此外,您可以通过撤消或删除对应用中产品的访问权限来控制对资源软件包的访问权限。

B

余额明细
对于预付费开发者,这是开发者账号的余额。

C

Cassandra

(仅限 Apigee Hybrid)运行时数据代码库,用于为网关上运行的应用存储应用配置、分布式配额计数器、API 密钥和 OAuth 令牌。

这是一个资源密集型 StatefulSet,应位于与消息处理器不同的工作器节点上。

如需了解详情,请参阅关于运行时平面

集中管理基础架构(或平面)
请参阅管理平面
容器[化]映像
查看映像。
控制平面
请参阅管理平面

D

部署

在 Apigee 中,您将 API 代理部署到环境,使其可供互联网上的应用客户端访问,公开或不公开,具体取决于您的网络配置。

开发者
开发者是指 Apigee 用户可以执行的角色。 Apigee 中有两种类型的开发者:
  • API 代理开发者 - 创建 API 代理并应用政策。
  • 应用开发者 - 创建使用 API 代理的应用。
开发者类别价格方案
适用于特定类别的所有开发者且可供该类别的所有开发者购买的价格方案。
开发者价格方案
适用于特定开发者且仅可供该开发者购买的价格方案。

E

环境

Apigee 环境是组织内独立部署 API 代理的软件环境。 该环境可以进行扩缩以满足部署的代理需求。 您可以在一个组织中创建多个环境。

环境组

环境组是一组具有一个或多个主机名的 Apigee 环境。主机名是用于调用部署到环境组中任何环境的 API 代理的网址的一部分。

显式限制
请参阅自定义限制

G

GCR
Google Container Repository.
GKE
Google Kubernetes Engine. Google 托管的生产就绪环境,用于将容器化应用部署到 Kubernetes。利用 GKE,您可以立即启动并运行 Kubernetes,完全无需安装、管理和运营您自己的 Kubernetes 集群。

I

映像代码库
一组共享容器映像。
隐式限制
通过获利设置的限制(例如开发者预付费余额限制)。
入站流量/入站流量控制器
一种容器化应用,用于将流量从集群外部路由到集群内的服务。

K

KMS
密钥管理服务存储、维护并提供用于加密和解密数据的密钥和 OAuth 令牌。Apigee KMS 将管理应用、开发者和 API 产品的密钥。
KVM
键值对映射已加密或未加密的键/值字符串对的自定义集合。如需了解详情,请参阅使用键值对映射
Kubernetes 管理机器
用于针对 Kubernetes 集群运行命令的本地机器。此机器通常是有权访问您的 Kubernetes 虚拟机的桌面机器。

M

管理层面
Google 托管的中央服务,通过服务账号与运行时平面进行通信。
MART

用于运行时数据的 API 与本地运行时数据存储区 (Cassandra) 互动。它充当公共 Apigee API 的 API 提供商,用于访问和管理运行时数据。

MART 是无状态应用,就像消息处理器一样。这是一个 Kubernetes 容器化应用。

如需了解详情,请参阅关于运行时平面

主节点
节点的 Kubernetes 术语,其中包括 apiserver、cloud-controller-manager (CCM)、调度器和 kube-controller-manager。
消息处理器

(仅限 Apigee Hybrid)消息处理器评估传入请求,执行所有 Apigee 政策,并调用后端系统和其他系统以检索数据。收到这些响应后,消息处理器会设置响应的格式并将其返回给客户端。

MP 是 Kubernetes 部署。它针对单个 Apigee 环境进行配置,指向 Synchronizer 向其提供数据的共享文件系统中的范围内子目录。

MP 是资源密集型,且应该位于 Cassandra 的单独工作器节点上。

如需了解详情,请参阅关于运行时平面

获利
Apigee 的一个组件,可提供易于使用且灵活的方式来通过 API 产品获利。
每月使用费
开发者在给定月份的总使用费,包括设置费 + 交易费 + 经常性费用。
按月付款
开发者根据所购买的方案进行的经常性付款。无论使用情况如何,价格方案均可每月向开发者收取经常性费用。

N

命名空间
用于拆分集群资源的虚拟集群。命名空间适用于拥有众多用户的较大集群;通常只有几十个用户的较小集群不需要命名空间。

O

打开调整
尚未在发布的结算文档中应用的调整。
打开结算月份
尚未发布最终结算文档的完整日历月。
开源 Kubernetes
Kubernetes 的参考实施。请参阅 Kubernetes。Apigee Hybrid 运行时在开源 Kubernetes 和兼容 CNCF 的开源 Kubernetes 版本上运行。
组织

一个容器,用于容纳 Apigee 账号中的所有实体,包括 API 代理、API 产品、API 软件包、应用和开发者。本文档交换使用 Apigee 组织支持 Hybrid 的组织这两个术语。

如需安装和使用 Apigee 或 Apigee Hybrid,您必须有一个绑定到 Google Cloud 项目的 Apigee 组织。在称为预配的流程中创建组织时可执行此项操作。

Apigee 组织与 Google Cloud 组织同。如果存在歧义,本文档规定组织Apigee 组织

如需了解详情,请参阅组织类型

P

pod
pod 是 Kubernetes 的基本构建块:您创建或部署的 Kubernetes 对象模型中的最小、最简单的单元。Pod 代表集群中正在运行的进程。
预付款余额
预付费开发者可用于提前支付 API 软件包的金额。
预付费开发者
提前支付 API 产品使用费的开发者。使用 API 产品时将从预付费开发者的余额中扣除相应资金。开发者必须保持足够预付款余额才能购买 API 产品。API 提供方会为开发者分配预付费或后付费状态。
政策
一项处理步骤,作为 API 流中可重复使用的原子化逻辑单元执行。典型的政策包括:将请求路由到正确的端点、转换消息格式、强制执行访问权限控制、调用远程服务获取其他信息、遮盖来自外部用户的敏感数据、检查消息内容是否存在潜在威胁、缓存常见响应来改善性能等。可以根据请求或响应消息的内容或上下文有条件地执行政策。例如,如果请求消息从智能手机发出,则可以执行转换政策以自定义响应格式。
后付费开发者
按月结算 API 产品使用费的开发者。开发者根据价格方案中设置的付款条件支付 API 产品使用费。API 提供方会为开发者分配后付费或预付费状态。
proxy
又称 API 代理API 代理是一种抽象层,可充当后端服务 API 的前端,并提供增值功能,例如安全、速率限制、配额、分析等。
代理端点
代理端点定义 API 代理与客户端应用互动的方式。您可以为代理端点配置基本路径,该基本路径是 API 代理响应的网址的一部分。 网址的格式为 https://hostname/basepath/pathsuffixes。 请参阅创建 API 代理

R

价格方案
获利 API 软件包中提供的 API 产品的使用费用、其他费用和收益分成的规范。
副本控制器
重新调度 Pod 并处理 Pod 的自我修复。
资源、资源路径
RESTful 概念,资源路径是对访问给定资源的网络路径进行标识的统一资源标识符 (URI)。
修订版本
捆绑到 API 代理中已编号且受版本控制的配置和策略软件包。应将该术语与“版本”加以区分,后者是面向开发者的 API 接口。请参阅下面的“版本”。
运行时平面

您在自己的 Kubernetes 集群上管理的 Apigee Hybrid 服务位于运行时平面中。这些服务通过服务账号与管理平面进行通信。

包括 MART、同步器、消息处理器、Cassandra 和其他组件。

如需了解详情,请参阅关于运行时平面

运行时实例
Apigee 可以配置多个运行时实例,每个地理区域一个。 可以将一个或多个环境连接到运行时实例,从而跨区域提供 API 代理的高可用性。

S

服务

在运行时平面的 Kubernetes 集群上运行的容器化应用的通用术语。这些服务包括 MART、同步器、消息处理器和 Cassandra。

如需了解详情,请参阅关于运行时平面

有状态节点
需要永久性存储来维持状态的集群节点。请参阅配置专用节点池
无状态节点
不需要永久性存储的集群节点。请参阅配置专用节点池
同步器

一种运行时平面服务,用于针对每个环境的部署配置和事件轮询管理平面。它会将有关已部署代理、代理配置文件等的所需元数据下载到运行时平面。

同步器将其信息存储在消息处理器读取的共享文件系统上。这将作为 DaemonSet 应用运行;它没有运行时 API 流量,并且可以从单个进程/Kubernetes Pod 同步多个环境的数据。

如需了解详情,请参阅关于运行时平面

T

目标端点

目标端点定义 API 代理与后端服务互动的方式。您可以配置目标端点以将请求转发到正确的后端服务,包括定义安全设置、HTTP 或 HTTPS 协议以及其他连接信息。请参阅更改目标端点

充值
预付费开发者执行以增加预付款余额中的资金的操作。
transaction_success_def" id="transaction_success_def">交易成功
获利变量(如果使用)表示 API 交易是否获利。 此变量可用于替换基于 HTTP 状态代码的默认行为。请参阅 获利变量

U

UAP

统一分析平台。管理层面中的一项 Apigee 服务,用于处理传入的分析、调试和部署状态数据,并通过 Apigee Hybrid 界面或 Apigee API 提供给您。

如需了解详情,请参阅调试、分析和部署状态数据收集

UDCA

通用数据收集代理。在运行时层面的数据收集 pod 中运行的服务,用于提取分析、调试和部署状态数据并将其发送到 UAP。

如需了解详情,请参阅调试、分析和部署状态数据收集

V

版本
面向开发者的 API 接口版本。例如 pivotaltracker.com/services/v3, or api.enterprise.apigee.com/v1。应将该术语与 revision 加以区分,后者是捆绑到 API 代理中已编号且受版本控制的配置和政策软件包。简而言之,API 接口具有版本,而 API 代理具有修订版本。
可供 Pod 中的所有容器化应用使用的共享存储。