管理部署

本页面适用于 Apigee 和 Apigee Hybrid。

预览 — Apigee API hub

此功能须遵守服务专用条款的“通用服务条款”部分中的“非正式版产品条款”。 非正式版功能“按原样”提供，可能只能获得有限的支持。 如需了解详情，请参阅发布阶段说明。

一个 API 可以有多个部署。例如：不同的预演环境或区域。部署是用户可以访问 API 的位置（地址）。可以将其中一个部署指定为推荐的部署。

部署标签页会显示具有修改权限的用户配置的 API 的所有部署。部署按环境名称的字母顺序列出。

查看 API 注册表架构

下图说明了 API Hub API、版本、部署和规范之间的关系。

参考	资源项	说明
	注册表	注册表是用作 API 目录的 API 的集合。
	版本	一个 API 可以有多个版本。版本应该对应于客户端可用于调用 API 的稳定接口。您可以指定其中一个版本作为推荐版本。在 semver 用语中，最佳做法是将版本指定为主要版本。
	部署	API 可能有多个部署，例如不同的预演环境或区域。 部署是用户可访问 API 的位置（地址）。可以将其中一个部署作为推荐部署。
	指定	建议但不要求按照格式规范描述 API 版本，通常使用不同的 API 规范格式。可以将其中一个规范格式作为主要格式，表示此版本的其他规范根据此格式派生而来。
	修订版本	部署具有修订历史记录。部署修订版本在适当的时候表示部署的特定实例，如果部署处理的 API 实现发生变化，则可以引用一个或多个规范修订版本。 规范具有修订历史记录。规范修订版本表示规范的后续实例，通常表示对规范内容的非重大更改。在 semver 术语中，修订版本可能对应于次要版本或点版本。

添加部署

要添加部署，请执行以下操作：

1. 在 Google Cloud 控制台中，转到 API Hub 页面。

   转到 API Hub

   默认情况下，系统会显示 API 列表页面。

2. 在 API 列表中，点击一个 API 行。默认情况下，系统会显示概览标签页。
3. 选择部署标签页。
4. 点击添加部署
5. 输入或选择下列字段：
   • ID：API 资源的标识符。ID 只能包含小写字母、数字和连字符。该 ID 在项目中必须唯一。ID 的长度必须介于 4 到 63 个字符之间。在创建部署后，便无法更改 ID。
   • 环境：API 实例所在的位置。 例如：生产、预演、测试等。
   • 网关：网关类型。用于传送和保护 API 的代理。定义为系统分类。

   • API 版本：此部署提供的 API 的版本。如果某个版本没有任何修订版本，则会在列表中对此进行标记且无法选择该版本。

     
   • 外部渠道名称和网址：指向 API 外部渠道（如开发者门户）的链接的标签和网址
   • 访问信息
     • 使用指南：指定部署受众群体的指南。 例如，公开使用、内部测试等。
     • 服务器端点：API 的服务器端点
     • 访问权限指南：自由格式的 Markdown 内容，说明 API 使用方如何获取对部署的访问权限
6. 点击保存（或取消）。

修改部署

要修改部署，请执行以下操作：

1. 在 Cloud 控制台中，转到 API Hub 页面。

   转到 API Hub

   默认情况下，系统会显示 API 列表页面。

2. 在 API 列表中，点击一个 API 行。默认情况下，系统会显示概览标签页。
3. 选择部署标签页。
4. 依次点击 更多 > 要修改的部署旁边的 修改。
5. 根据需要进行修改。

6. 更新修订版本：如果当前所选版本的某个规范修订版本比已分配给部署的修订版本更新，那么系统便会显示此复选框。选中此复选框便可更新已部署的规范修订版本。

   
7. 点击保存（或取消）。

删除部署

如需删除部署，请执行以下操作：

1. 在 Cloud 控制台中，转到 API Hub 页面。

   转到 API Hub

   默认情况下，系统会显示 API 列表页面。

2. 在 API 列表中，点击一个 API 行。默认情况下，系统会显示概览标签页。
3. 选择部署标签页。
4. 点击 更多 > 所需部署旁边的 删除。
5. 点击提示中的删除（或取消）。

指定推荐的部署

如需设置或清除建议的部署，请执行以下操作：

1. 在 Cloud 控制台中，转到 API Hub 页面。

   转到 API Hub

   默认情况下，系统会显示 API 列表页面。

2. 在 API 列表中，点击一个 API 行。默认情况下，系统会显示概览标签页。
3. 选择部署标签页。
4. 在所需的部署行上，点击 更多 > 设为推荐项。您无法清除推荐的部署；您只能指定其他部署作为推荐的部署。

获取访问权限

注意：访问权限信息是在部署过程中指定的。如需了解详情，请参阅添加部署。

要查看有关如何获取对 API 的访问权限的信息，请执行以下操作：

1. 在 Cloud 控制台中，转到 API Hub 页面。

   转到 API Hub

   默认情况下，系统会显示 API 列表页面。

2. 在 API 列表中，点击一个 API 行。默认情况下，系统会显示概览标签页。
3. 从常规窗格或部署标签页中，点击获取访问权限以打开 Access API 面板。如果没有获取访问权限按钮，则不会提供任何信息。如需了解如何添加访问权限信息，请参阅添加部署。

4. 从列表中选择部署。如果部署没有访问权限信息，则会在列表中标记出来，并且无法选择。

   

转到外部渠道

注意：当您创建部署时，系统会定义外部渠道。如需了解详情，请参阅添加部署。

要导航到外部渠道，请执行以下操作：

1. 在 Cloud 控制台中，转到 API Hub 页面。

   转到 API Hub

   默认情况下，系统会显示 API 列表页面。

2. 在 API 列表中，点击一个 API 行。默认情况下，系统会显示概览标签页。
3. 选择部署标签页。

4. 点击外部渠道链接，前往外部渠道，例如门户（如果已定义）。