Apigee API Hub

借助 Apigee API Hub 连接器，您可以管理、发现和监管组织产品组合中的 API。

支持的版本

此连接器支持 Apigee API Hub 版本 v1。

准备工作

  • 在 Google Cloud 项目中，执行以下任务：

    • 确保已设置网络连接。如需了解网络模式，请参阅网络连接。
    • 向配置连接器的用户授予 roles/connectors.admin IAM 角色。
    • 启用以下服务：
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      如需了解如何启用服务，请参阅启用服务。如果之前没有为您的项目启用这些服务或权限，则在您配置连接器时，系统会提示您启用。

  • 如果您使用的是服务账号身份验证，而不是 OAuth 2.0 身份验证，请确保向服务账号授予适当的权限。如需了解详情，请参阅预定义的 IAM 角色。

创建 Apigee API Hub 连接

一个连接需专用于一个数据源。这意味着，如果您有许多数据源，则必须为每个数据源创建单独的连接。如需创建连接，请执行以下操作：

  1. 在 Cloud 控制台 中，进入 Integration Connectors > 连接页面，然后选择或创建一个 Google Cloud 项目。

    转到“连接”页面

  2. 点击 + 新建以打开创建连接页面。
  3. 在位置部分中，从区域列表中选择一个位置，然后点击下一步。

    如需查看所有受支持区域的列表，请参阅位置。

  4. 在连接详情部分中，执行以下操作：
    1. 从连接器列表中选择 Apigee API Hub。
    2. 从连接器版本列表中选择一个连接器版本。
    3. 在连接名称字段中，输入连接实例的名称。连接名称可以包含小写字母、数字或连字符。 名称必须以字母开头，以字母或数字结尾，且不得超过 49 个字符。
    4. （可选）输入连接实例的说明。
    5. 您可以选择启用 Cloud Logging，然后选择日志级别。默认情况下，日志级别设置为 Error。
    6. 服务账号：选择具有所需角色的服务账号。
    7. （可选）配置连接节点设置。
      • 节点数下限：输入连接节点数下限。
      • 节点数上限：输入连接节点数上限。

      节点是处理事务的连接单元（或副本）。 连接处理越多事务就需要越多节点，相反，处理越少事务需要越少节点。 如需了解节点如何影响连接器价格，请参阅 连接节点的价格。如果未输入任何值，则默认情况下，节点数下限设置为 2（以便提高可用性），节点数上限设置为 50。
    8. 点击下一步。
  5. 在目标部分中，输入要连接到的远程主机（后端系统）的详细信息。
    1. 在目标类型字段中，选择一个目标。
    2. 在主机地址字段中，指定目标的主机名或 IP 地址。

    3. （可选）如需输入其他目的地，请点击 + 添加目的地。

    4. 点击下一步。
  6. 在身份验证部分中，输入身份验证详细信息。
    1. 选择身份验证类型，然后输入相关详细信息。

      Apigee API Hub 连接支持以下身份验证类型：

      • OAuth 2.0 - 授权代码
      • 服务账号身份验证

      2. 如需了解如何配置这些身份验证类型，请参阅配置身份验证。

    2. 点击下一步。
  7. 查看您的连接和身份验证详细信息，然后点击创建。

配置身份验证

根据您要使用的身份验证输入详细信息。

  • OAuth 2.0 - 授权代码：选择此选项可使用基于网页的用户登录流程进行身份验证。请指定以下详细信息：
    • 客户端 ID： 连接到后端 Apigee API Hub 服务所需的客户端 ID。
    • 范围： 以英文逗号分隔的所需范围列表。如需查看所需 Google 服务的所有受支持的 OAuth 2.0 范围，请参阅 Google API 的 OAuth 2.0 范围页面中的相关部分。
    • 客户端密钥： 选择 Secret Manager 密钥。 您必须先创建 Secret Manager 密钥，然后再配置此授权。
    • 密钥版本：客户端密钥的 Secret Manager 密钥版本。

    对于 Authorization code 身份验证类型，创建连接后，您必须授权该连接。

  • 服务账号身份验证：选择此选项可使用您在配置此连接时在前面的步骤中提供的服务账号进行身份验证。确保您已为服务账号提供身份验证所需的相应 IAM 角色和权限。
    • 范围： 从下拉菜单中选择所需的 OAuth 2.0 范围。如需了解详情，请参阅访问权限范围。

授权关联

如果您使用 OAuth 2.0 - 授权代码来验证连接，请在创建连接后完成以下任务。

  1. 在“连接”页面中，找到新创建的连接。

    请注意，新连接器的状态将为需要授权。

  2. 点击需要授权。

    系统会显示修改授权窗格。

  3. 将重定向 URI 值复制到外部应用。
  4. 验证授权详细信息。
  5. 点击授权。

    如果授权成功，系统会在“连接”页面中将连接状态设置为有效。

授权代码的重新授权

如果您使用的是 Authorization code 身份验证类型，并且在 Apigee API Hub 中进行了任何配置更改，则必须重新授权您的 Apigee API Hub 连接。如需重新授权连接，请执行以下步骤：

  1. 在“连接”页面中，点击所需的连接。

    系统随即会打开连接详情页面。

  2. 点击修改以修改连接详细信息。
  3. 在身份验证部分中，验证 OAuth 2.0 - 授权代码详细信息。

    如有需要，请进行必要的更改。

  4. 点击保存。系统随即会转到连接详情页面。
  5. 在身份验证部分中，点击修改授权。系统会显示授权窗格。
  6. 点击授权。

    如果授权成功，系统会在“连接”页面中将连接状态设置为有效。

系统限制

Apigee API Hub 连接器最多可以每节点每秒处理 20 个事务，并且会限制超出此限制的任何事务。默认情况下，Integration Connectors 会为连接分配 2 个节点（以提高可用性）。

如需了解适用于 Integration Connectors 的限制，请参阅限制。

在集成中使用 Apigee API hub 连接

创建连接后，连接将在 Application Integration 中可用。您可以通过连接器任务在集成中使用该连接。

操作

此连接器为所连接的后端服务的对象提供了一个抽象层。您只能通过此抽象访问后端的对象。抽象作为动作向您展示。Action 是可通过连接器接口提供给集成的一流函数。动作可让您对一个或多个实体进行更改，并且动作因连接器而异。但可能的情况是，连接器不支持任何操作，在这种情况下，Actions 列表将为空。

已知问题

Apigee API Hub 连接器具有配置限制。可搜索的资源大小上限为 2.5 MB，API 规范文件大小上限为 10 MB。 如需了解详情，请参阅 Apigee API Hub 的限制。

向 Google Cloud 社区寻求帮助

您可以在 Google Cloud 社区的 Cloud 论坛中发布您的问题以及讨论此连接器。

后续步骤