<ph type="x-smartling-placeholder"></ph>
您正在查看 Apigee Edge 文档。
转到
Apigee X 文档。 信息
组织是 Apigee Edge 中的顶层容器。它包含您的所有 API 代理及相关资源。虽然本主题的其余部分更加深入地介绍了组织,但是下面列出了一些有用的要点:
- 默认情况下,您的组织名称位于用于调用 API 代理的网址中,因为
关于虚拟主机中的说明。
例如:
http(s)://your_org_name-environment.apigee.net/proxy_base_path/...
- 您可以在 Edge 管理界面的网址中找到贵组织的名称。例如,以下网址显示了
docs
组织的 API 代理: - 虽然您可能只创建了一个组织,但是您可以作为拥有特定权限的用户或管理员属于其他组织。在 Edge 管理界面中,如果您属于 ,则可以按照在组织之间切换中的说明切换到其他组织。
- 当您以 Organization Administrator 用户的身份使用 Management API 进行调用时
角色,那么组织在大多数调用中都是路径中不可或缺的组成部分。例如,以下
Management API c网址 请求会返回组织中所有 API 代理的列表:
curl https://api.enterprise.apigee.com/v1/organizations/your_org_name/apis -u org_admin_email_address
视频:观看一段短视频,了解组织如何支持 API 管理的多租户架构。
组织组件
创建 Edge 账号时,Edge 会自动为您创建组织。一次 您就可以向贵组织添加用户、创建 API 代理和 API 产品, 注册开发者和应用。
下图显示了 Edge 组织模型的主要组件。这个 模型定义了 API、API 产品、应用和应用开发者 Edge。
此模型并未显示 Apigee Edge 的所有功能。如果您使用创收功能 那么模型就会有其他组件。如需了解详情,请参阅 创收概况。请参阅 管理公司和开发者 了解如何利用创收功能管理公司和开发者。
<ph type="x-smartling-placeholder">组织名称
组织名称为:
- 评估组织:
username-eval
- 付费组织:用户在初始配置时定义
组织一经创建便无法重命名。
组织名称会成为 API 代理网址中的一部分, 向 Edge Management API 发出请求。例如,用于访问 API 的典型网址 代理的格式如下:
http://org-name-env.apigee.net/v1/weather/forecastrss
其中:
- org-name 是您组织的名称。
- env 是 API 代理的部署环境,可以是测试,也可以是 生产环境。
例如:
http://myorg-test.apigee.net/v1/weather/forecastrss
组织组件
下表更详细地描述了组织模型的组件:
组件 | 说明 |
---|---|
组织 |
每个 Apigee 账号都会映射到 Apigee Edge 上的一个或多个组织。通过 组织包含所有组件的表示法,包括 API 代理、API 包括产品、API 软件包、应用和开发者。 账号持有人并不限于单个组织。某些账号持有人可能会定义或成为支持不同应用开发者社区的多个组织。 |
环境 | 组织中 API 代理的运行时执行上下文。请参阅本节内容 。 |
用户 |
在组织内,创建账号的人会自动成为 您可以创建更多用户。用户构成组织的 API 团队 其中包括管理员、API 代理和 API 产品创建者等人员, 用户监控 Google Analytics 和其他统计信息,以及任何其他信息。 不同的用户可以拥有不同的角色和访问权限。例如,将部分用户定义为组织管理员和操作管理员,他们有权修改组织及其组件。定义其他用户,他们有权创建 API 代理和 API 产品,但是无权修改其他用户。 用户可以是多个组织的成员。例如,您的公司可以定义 多个组织使用 Apigee Edge,从而为不同的开发者社区提供支持。 但是在内部,同一个人员构建所有 API 代理和 API 产品,因此属于您的所有组织的成员。 要成为用户,您不需要创建 Apigee 账号(即创建 Apigee 组织)。管理员可以将您添加到现有组织。 所有用户均可在此处登录 Apigee Edge: https://enterprise.apigee.com. |
API 代理 |
组织中的用户会创建一个或多个 API 代理。API 代理定义了公共可用 HTTP 端点到后端服务的映射。API 代理也可以配置为包含安全性(如 OAuth)、执行消息转换(例如 XML 到 JSON)、限制发送到后端服务的流量以及对请求、响应和服务调用执行其他有价值的操作。 Edge 会收集 API 代理数据以进行分析。 |
API 产品 |
组织中的用户创建了一个或多个 API 产品,而 API 产品是 将 API 代理与服务方案相结合。该服务计划可以设置 限制 API 代理,提供安全性,支持监控和分析, 其他功能 Edge 会收集 API 产品数据进行分析。 |
开发者 |
组织包含一个或多个开发者,他们构建使用您的组织定义的 API(内置于 API 产品中)的应用。开发者使用 API,但不能创建 API,也不能在组织中执行任何其他操作。 开发者可以是贵公司的内部人员、可以是合作伙伴,也可以是 付费使用 API 的外部开发者。 您必须先在组织中注册开发者,然后他们才能注册应用并接收用于访问 API 的 API 密钥。作为 API 提供方,您自行决定如何在组织中添加、更新或移除开发者。您可以手动添加 创建开发者门户,以便通过 网站,也可以使用 Edge 管理功能定义自己的注册机制, API。 开发者无需拥有 Edge 账号,而且大多数开发者 需要了解 Edge如果开发者有 Edge 账号, (通常是以其他组织中的用户的身份),或是使用 Edge API 服务。 |
应用 |
开发者会创建一个或多个使用您的 API 的客户端应用。 开发者必须向您的组织注册其应用。Edge 中的应用是 表示开发者实际应用程序,它为开发者提供 API 密钥, 会随每个请求一起传入您的 API 由于所有应用都是在贵组织中注册的,因此您可以使用 Edge 来监控和 收集有关应用及其 API 使用情况的分析信息。 |
API 密钥/OAuth 令牌 |
根据您为 API 定义的授权机制,应用会传递 API 密钥以及向您的 API 发出的每个请求。如果该键有效,则请求 允许。Edge 支持不同类型的身份验证,例如简单的 API 密钥, 两方模式 OAuth、三方模式 OAuth 等。 作为 API 提供商,您必须定义开发者注册其应用的方法。该方法是注册应用,以向开发者返回访问您的 API 所需的密钥。 在注册应用时,开发者可以选择访问一个 API 一个或多个 API 产品开发者的实际应用使用相同的密钥来访问 与应用相关联的所有 API 产品( 开发者的应用)。 您可以随时撤消密钥,这样开发者的应用便无法再访问您的 API(即使开发者应用的注册表示法仍存在于您的组织中)。或者,您可以定义密钥的时间限制,以便开发者必须在特定时间之后刷新密钥。 |
关于环境
环境是组织中 API 代理的运行时执行上下文。您必须先将 API 代理部署到环境,然后才能对其进行访问。您可以将 API 代理部署到单个环境或多个环境。
一个组织可以包含多个环境。例如,您可以定义一个 dev
,
组织中的 test
和 prod
环境。
组织提供某些 Apigee 功能的范围。例如,键值对映射 (KVM) 组织级别的数据都可以访问,这意味着部署到任何数据中心的 API 代理 环境会从 KVM 获取相同的数据。部分功能(例如缓存)可以限定为 组织或组织中的特定环境。 Apigee 分析数据按组织和环境的组合进行分区。
下面显示了您在组织内管理的主要实体,包括组织中全局定义的实体以及专门针对环境定义的实体: