预配 API Hub

本页面适用于 Apigee 和 Apigee Hybrid。

本主题介绍了如何使用 Google Cloud 控制台中的 Apigee 界面预配 API Hub。这是预配 API Hub 的建议方法。图 1 突出显示了此预配文档中所述的基本步骤。

图 1. 预配 Apigee API Hub 实例的步骤。

准备工作

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

5. Make sure that billing is enabled for your Google Cloud project.

6. Make sure that you have the following role or roles on the project:

   • roles/serviceusage.serviceUsageAdmin
   • roles/cloudkms.admin
   • roles/apihub.provisioningAdmin
   • roles/resourcemanager.projectIamAdmin

   Check for the roles

   1. In the Google Cloud console, go to the IAM page.

      Go to IAM
   2. Select the project.

   3. In the Principal column, find all rows that identify you or a group that you're included in. To learn which groups you're included in, contact your administrator.

   4. For all rows that specify or include you, check the Role colunn to see whether the list of roles includes the required roles.

   Grant the roles

   1. In the Google Cloud console, go to the IAM page.

      前往 IAM
   2. 选择项目。
   3. 点击 授予访问权限。

   4. 在新的主账号字段中，输入您的用户标识符。 这通常是 Google 账号的电子邮件地址。

   5. 在选择角色列表中，选择一个角色。
   6. 如需授予其他角色，请点击 添加其他角色，然后添加其他各个角色。
   7. 点击保存。

   步骤摘要

   预配步骤如下：

   1. 第 1 步：启用 API。Apigee 要求您启用一些 Google Cloud API。
   2. 第 2 步：选择托管位置。指定 API Hub 的物理位置。
   3. 第 3 步：注册宿主项目。默认情况下，系统会选择当前的 Google Cloud 项目。
   4. 第 4 步：配置加密。选择或创建客户管理的加密密钥 (CMEK)，或使用 Google 管理的加密密钥 (GMEK) 对静态 API 数据进行加密和解密。
   5. 第 5 步：创建服务身份。为服务身份分配访问权限。
   6. 创建 API Hub 实例。预配需要几分钟才能完成。

   预配步骤

   如需为 API Hub 启动预配，请执行以下操作：

   1. 确保您已满足准备工作中所述的前提条件。

   2. 在 Google Cloud 控制台中，前往 Apigee API Hub 欢迎页面。

      前往 Apigee API Hub

   3. 点击创建实例。
      • 如果您的组织中未预配 API Hub，则界面会显示预配工作流的第 1 步。
      • 如果 API Hub 已预配，系统会将您转到 API 资源页面。

   第 1 步：API

   如需预配 API Hub，您必须为 Google Cloud 项目启用以下 API：

   API 名称	位置	说明
   API Hub API	apihub.googleapis.com	API Hub API。
   Cloud Key Management Service (KMS)	cloudkms.googleapis.com	管理密钥并执行加密操作，以供其他 Cloud 资源直接使用。

   要启用所需的 API，请点击启用 API。此步骤需要几秒钟才能完成。

   第 2 步：位置

   您需要选择两个位置：首先，要托管 Apigee API Hub 实例的物理位置（区域）；其次，要存储 Vertex AI 搜索数据的多区域：

   1. 从下拉列表中，选择要托管 API Hub 实例的区域。支持的位置包括：

      区域说明	区域名称
      艾奥瓦	us-central1
      北弗吉尼亚	us-east4
      俄勒冈	us-west1
      比利时	europe-west1
      伦敦	europe-west2
      新加坡	asia-southeast1
      孟买	asia-south1
      圣保罗	southamerica-east1
      悉尼	australia-southeast1

   2. 如果启用 Vertex 搜索功能选项处于启用状态（默认），您必须选择用于存储基于 Vertex AI 的搜索数据（与 API Hub 的语义搜索功能相关联的数据）的多区域位置。默认情况下，系统会选择包含您在第 1 步中设置的 API Hub 区域的多区域。例如，如果您选择 us-central1 作为 API Hub 区域，系统会默认选择多区域 us。不过，如果您愿意，可以随时改用其他多区域。

      Vertex 搜索选项可启用 API Hub 的 Vertex AI 赋能语义搜索功能。如果您取消选择启用 Vertex 搜索功能选项，语义搜索功能将停用，多区域选择器将被隐藏。

   注意：选择 Vertex 搜索选项后，系统会自动在与 API Hub 托管区域位于同一多区域的 Google Cloud 区域中预配 Vertex AI。例如，如果您选择 us-central1 作为 API Hub 的托管区域，则可以在 us 多区域内的任何区域预配 Vertex。例如，可以在 us-west1、us-west2、us-central2 或 US 多区域内的其他区域预配 Vertex。
   3. 点击设置位置。

   第 3 步：注册宿主项目

   宿主项目是您在 Apigee 组织中指定为所有 API Hub 资源的使用方项目的 Google Cloud 项目。可以为每个宿主项目预配单个 API Hub 实例。

   如需将您的 Apigee 组织的 Google Cloud 项目用作 API Hub 的宿主项目，请点击注册。

   第 4 步：加密

   在此步骤中，您可以选择使用 Google 管理的加密密钥 (GMEK) 或在 Cloud Key Management Service 中定义的客户管理的加密密钥 (CMEK)，以加密存储在 API Hub 实例中的数据。

   如需使用 Google 管理的加密密钥，只需选择 Google 管理的加密密钥选项。如果您选择此选项，则无需进行其他密钥配置。

   如需使用现有的 CMEK，请执行以下操作：

   1. 在选择客户管理的加密密钥 (CMEK) 框中，输入内容以进行过滤或滚动以搜索现有密钥。或者，您也可以输入密钥的资源 ID 来查找现有密钥。
   2. 选择您的密钥，然后点击确定。
   3. 点击确认。

   如需创建新的 CMEK，请执行以下操作：

   1. 点击创建密钥。 此时将出现创建新密钥对话框。
   2. 在密钥环部分中，您可以指定现有密钥环或创建新的密钥环。
      • 如需使用现有密钥环，请执行以下操作：
        1. 从密钥环列表中选择一个现有密钥环。
        2. 点击继续。
      • 如需创建新的密钥环，请执行以下操作：
        1. 点击创建密钥环切换开关，或点击选择框中的创建密钥环。
        2. 在密钥环名称字段中，输入密钥环的名称。

           密钥环名称可以包含字母、数字、下划线 (_) 和连字符 (-)。不能重命名或删除密钥环。

        3. 从密钥环位置列表中选择一个位置。

           此位置仅限于您在上一步选择的托管位置，以确保密钥和数据保留在同一区域中。

        4. 点击继续。
   3. 在“密钥”部分中执行以下操作：
      1. 在密钥名称字段中输入密钥的名称。

         密钥名称可以包含字母、数字、下划线 (_) 和连字符 (-)。不能重命名或删除密钥。

      2. 选择保护级别，例如软件。
      3. 点击继续。
   4. 在审核部分中，确认您为密钥创建指定的详细信息。

      如果信息正确，请点击创建。

      警告：密钥和密钥环一经创建便无法删除。如需了解详情，请参阅“为什么我不能删除密钥或密钥环？”。
   5. 在 Choose a customer-managed encryption key（选择客户管理的加密密钥）框中选择新创建的密钥。
   6. 点击确认加密密钥。

   第 5 步：服务身份

   在此步骤中，您将创建一个新的服务身份，并为其授予您选择的客户管理的加密密钥的权限。此密钥用于加密和解密 API Hub 数据。

   如需创建新的服务身份，请点击创建服务身份并授予权限。

   Apigee 会创建一个服务账号，并为该服务账号分配 cloudkms.cryptoKeyEncrypterDecrypter、apihub.admin 和 apihub.runtimeProjectServiceAgent 角色。

   创建 API Hub 实例

   点击提交以创建 API Hub 实例。

   预配开始后，系统会显示 Finalizing API hub instance（正在完成 API Hub 实例）页面。此步骤需要几分钟才能完成。

   预配完成后，系统会显示 API Hub API 页面。

   注意：如果您在具有 Apigee 代理的项目中预配 API Hub，则此类代理会在预配 API Hub 后的几小时内自动在 API Hub 中注册。例如，如果您在 test-project-1 中预配 API Hub，并且此项目具有 Apigee 代理，则 test-project-1 会自动作为运行时项目附加，并且 test-project-1 中的代理会在 API Hub 中注册。

   后续步骤

   恭喜！您已成功预配 API Hub。

   现在您可以开始使用 API Hub：

   • 查看使用 API Hub 所需的角色和权限
   • 配置 API Hub 属性：
     • 管理属性
     • 快速入门：创建和修改属性
   • 注册 API 资源：
     • 管理 API 资源
     • 快速入门：注册 API
   • 添加 API 版本：
     • 版本概览
     • 快速入门：创建 API 版本