创建自定义连接器

本页面介绍了如何创建自定义连接器。要了解什么是自定义连接器， 请参阅自定义连接器。

要使用自定义连接器与后端建立连接，请执行以下操作： 您需要执行以下任务：

  1. 创建自定义连接器 - 在此任务中，您将定义合同 。目前仅支持 OpenAPI 3.0 版及其所有次要版本。指定该规范属于一次性活动。
  2. 创建自定义连接器连接 - 在此任务中，您将配置 您后端的连接详情，例如主机名和身份验证。对于 则可以根据需要创建任意数量的连接。

如需了解连接器与连接之间的区别，请参阅连接器与连接。

准备工作

确保创建自定义连接器的用户符合以下任一条件 IAM 角色：

创建自定义连接器

如 后端连接 场景，自定义连接器可以具有以下任一连接模式：

  • 与后端公共端点的直接连接。
  • 通过中间公共端点间接连接到后端。

对于这两种模式，自定义连接器创建步骤略有不同。

通过直接连接创建

如需创建与后端端点直接连接的自定义连接器，请执行以下操作： 请按以下步骤操作：

控制台

  1. 在控制台中，前往 集成连接器 > 自定义连接器页面， 然后选择或创建一个 Google Cloud 项目

    转到“自定义连接器”页面

  2. 点击新建，打开创建自定义连接器页面。
  3. 在连接器详细信息部分，设置以下字段：
    1. 连接器名称：输入连接器的名称。
    2. 显示名称：输入连接器的显示名称。
    3. 说明：输入说明。
    4. 服务账号：选择一个符合以下条件的服务账号 拥有所需的角色。
    5. 徽标：将图片上传到 Cloud Storage 存储桶，以将其用作连接器徽标。
  4. 点击下一步。
  5. 在连接器规范部分，设置以下字段：
    1. 自定义连接器类型：选择自定义连接器类型。
    2. 连接器规范：输入 Open API 规范的公开网址，或将您的规范文件上传到 Cloud Storage 存储桶。
  6. 查看连接器配置详细信息，然后点击创建。

如果连接器创建成功，则新创建的连接器将 显示在中 转到“自定义连接器”页面，如果是新连接器， 该连接器也会创建您可以在版本页面查看版本详情 自定义连接器详细信息页面的标签页上。如需了解详情，请参阅 图标。

但请注意，要连接到后端 您必须为新创建的连接器创建连接。如需更多信息 请参阅创建自定义连接器连接。

API

以下示例命令显示了如何使用 Integration Connectors API 创建自定义连接器：

  1. 创建连接器。 
    curl -X POST \
-H "authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json"
-d '{"customConnectorType":"OPEN_API", \
"displayName":"CUSTOM_CONNECTOR_NAME", \
"description": "an open api based custom connector for hrms"}' \
"https://connectors.googleapis.com/v1/projects/PROJECT_ID/locations/global/customConnectors?custom_connector_id=UNIQUE_IDENTIFIER"

    请替换以下内容：

    • CUSTOM_CONNECTOR_NAME：自定义连接器的名称。
    • PROJECT_ID：您的 Google Cloud 项目的 ID。
    • UNIQUE_IDENTIFIER：连接器的唯一标识符。例如 custom-connector-1。
  2. 配置自定义连接器版本。 
    curl -X POST \
-H "authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{"spec_location": "SPECIFICATION_URL",}' \
"https://connectors.googleapis.comv1/projects/PROJECT_ID/locations/global/customConnectors/openapi-customconnector/customConnectorVersions?custom_connector_version_id=VERSION_NUMBER"

    3. 请替换以下内容：

    • SPECIFICATION_URL：Open API 规范网址。对于 示例 https://petstore3.swagger.io/api/v3/openapi.json。
    • PROJECT_ID：您的 Google Cloud 项目的 ID。
    • VERSION_NUMBER：连接器的版本号。例如 2。

通过间接连接创建

要创建通过以下应用连接到后端的自定义连接器： 中间端点，请执行以下步骤：

控制台

  1. 在控制台中，前往 集成连接器 > 自定义连接器页面， 然后选择或创建一个 Google Cloud 项目

    转到“自定义连接器”页面

  2. 点击新建，打开创建自定义连接器页面。
  3. 在连接器详细信息部分，设置以下字段：
    1. 连接器名称：输入连接器的名称。
    2. 显示名称：输入连接器的显示名称。
    3. 说明：输入说明。
    4. 为后端访问配置连接器目标位置：启用此选项。这会显示该页面的其他配置部分。
    5. 服务账号：选择具有所需角色的服务账号。
    6. 徽标：将图片上传到 Cloud Storage 存储桶，以将其用作连接器徽标。
  4. 点击下一步。
  5. 在连接器规范部分，设置以下字段：
    1. 自定义连接器类型：选择自定义连接器类型。
    2. 连接器规范：输入 Open API 规范的公开网址，或将您的规范文件上传到 Cloud Storage 存储桶。
  6. 点击下一步。
  7. 在连接器目标部分中，设置以下字段：
    1. 目标类型：选择主机地址。
    2. 主机：输入中间服务运行的主机名。
    3. Port：输入中间服务的端口号。
  8. 点击下一步。
  9. 在连接器身份验证部分，选择 中间服务的身份验证类型 按照提示输入相应的详细信息。此步骤用于配置 从 Integration Connectors 到中间服务的身份验证。

    身份验证 无法配置从中间服务到后端的配置 Integration Connectors 中；则由中间服务决定 向后端进行身份验证

  10. 点击下一步。
  11. 在后端变量部分，输入 您希望通过中间服务发送到后端。您 必须将值配置为键值对 paris。要输入键值对 点击添加变量，然后设置以下字段：
    • 密钥：输入密钥名称。
    • 值类型：选择变量的数据类型。
    • 显示名称：输入显示名称。
    • 位置：指定连接器发送内容的方式 将变量传递给中间服务可用的选项 是；Header、Request payload和Query parameter。
    • （可选）选择 Required 以指定 该变量是必填变量。
    。
  12. 点击下一步。
  13. 查看连接器配置详细信息，然后点击创建。

如果连接器创建成功，则新创建的连接器将 显示在自定义 连接器网页，如果是新连接器，则使用 该连接器也会创建您可以在版本页面查看版本详情 自定义连接器详细信息页面的标签页上。如需了解 创建和修改自定义连接器版本，请参阅 管理自定义连接器版本。

但请注意，要连接到后端 您必须为新创建的连接器创建连接。如需更多信息 请参阅创建自定义连接器连接。

API

以下示例命令显示了如何使用 Integration Connectors API 创建自定义连接器：

  1. 创建连接器。 
    curl -X POST \
-H "authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json"
-d '{"customConnectorType":"OPEN_API", \
"displayName":"CUSTOM_CONNECTOR_NAME", \
"description": "an open api based custom connector for hrms"}' \
"https://connectors.googleapis.com/v1/projects/PROJECT_ID/locations/global/customConnectors?custom_connector_id=UNIQUE_IDENTIFIER"

    请替换以下内容：

    • CUSTOM_CONNECTOR_NAME：自定义连接器的名称。
    • PROJECT_ID：您的 Google Cloud 项目的 ID。
    • UNIQUE_IDENTIFIER：连接器的唯一标识符。例如 custom-connector-1。
  2. 配置自定义连接器版本和身份验证。 
    curl -X POST \
-H "authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{"spec_location": "SPECIFICATION_URL", \
"service_account":"test-sa", \
"enable_backend_destination_config": true, \
"auth_config": { \
"auth_type":"USER_PASSWORD", \
"auth_key": "basic", \
"user_password": { \
"username":"USERNAME", \
"password": {"secret_version":"projects/PROJECT_ID/secrets/fidelity-secret/versions/SECRET_VERSION_NUMBER"} \
}}, \
"backend_variable_templates": [{ \
"key":"authkey", \
"value_type":"SECRET", \
"display_name":"Authorization Key", \
"required":true, \
"location_type": "HEADER" \
}], \
"destination_configs":[{ \
"key":"base_url", \
"destinations": [{ \
"host":"DESTINATION_HOST_ADDRESS" \
}]} \
]}' \
"https://connectors.googleapis.com/v1/projects/PROJECT_ID/locations/global/customConnectors/facade-connector/customConnectorVersions?custom_connector_version_id=CONNECTOR_VERSION_NUMBER"

    3. 请替换以下内容：

    • SPECIFICATION_URL：Open API 规范网址。对于 示例 https://petstore3.swagger.io/api/v3/openapi.json。
    • PROJECT_ID：您的 Google Cloud 项目的 ID。
    • USERNAME：用于向中间服务进行身份验证的用户名。
    • SECRET_VERSION_NUMBER：Secret Manager 密钥版本号。例如 2。
    • DESTINATION_HOST_ADDRESS：中间服务的主机地址。例如 http://www.test.com:80。
    • CONNECTOR_VERSION_NUMBER：自定义连接器版本号。例如 1。
    。

创建自定义连接器连接

创建自定义连接器后，要连接到后端，您需要 必须创建自定义连接器类型的连接。以下是 创建新连接的简要步骤：

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

    转到“连接”页面

  2. 点击新建，打开创建连接页面。
  3. 在位置部分的区域字段中，选择连接的位置。

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

  4. 点击下一步。
  5. 在连接详情部分，设置以下字段：
    1. 连接器：从可用连接器下拉列表中选择自定义连接器。
    2. 连接器版本：从可用版本的下拉列表中选择一个连接器版本。
    3. 在连接名称字段中，输入连接的名称。

      连接名称必须符合以下条件：

      • 连接名称可以使用字母、数字或连字符。
      • 字母必须小写。
      • 连接名称必须以字母开头，以字母或数字结尾。
      • 连接名称不能超过 63 个字符。
    4. （可选）输入连接的说明。
    5. （可选）选择启用 Cloud Logging 以启用云日志记录。
    6. 服务账号：选择一个符合以下条件的服务账号 拥有所需的角色。
    7. （可选）配置连接节点设置：

      • 节点数下限：输入连接节点数下限。
      • 节点数上限：输入连接节点数上限。

      节点是处理事务的连接单元（或副本）。 连接处理越多事务就需要越多节点，相反，处理越少事务需要越少节点。 如需了解节点如何影响连接器价格，请参阅连接节点的价格。如果未输入任何值，则默认情况下，节点数下限设置为 2（以便提高可用性），节点数上限设置为 50。

    8. （可选）点击添加标签以添加标签 以键值对的形式连接
  6. 点击下一步。
  7. 在 Authentication（身份验证）部分中，输入身份验证详细信息 使用
    • 如果您直接连接到后端，Integration Connectors 会提示您 为您的后端配置身份验证。
    • 如果您通过中间服务间接连接到后端， Integration Connectors 不会提示您配置身份验证详细信息。创建连接器时， 那么您可能已经在 Integration Connectors 和 使用中转服务Integration Connectors 不要求您配置身份验证 中间服务与后端之间的连接取决于中转机构 以了解其希望如何使用后端进行身份验证。
  8. 点击下一步。
  9. 查看连接配置详细信息，然后点击创建。

如果连接创建成功，则会在“所有连接”页面中列出。 并且该连接可用于 Application Integration 中。您可以使用连接 通过连接器任务在集成中进行设置。

注意事项

创建自定义连接器时，请注意以下几点：

  • Integration Connectors 仅支持 OpenAPI 3.0 版及其所有次要版本。
  • 在创建自定义连接器期间，系统不会验证 Open API 规范。当您 为自定义连接器创建连接，Integration Connectors 会验证规范， 如果出现错误，连接将处于 Error 状态。
  • Integration Connectors 不会区分实体和操作。因此，您的后端的实体和操作都将列为 Actions。
  • 启用了 VPC Service Controls 的 Google Cloud 项目不支持自定义连接器。
  • Open API 规范端点和后端端点都应可公开访问。也就是说 建立与后端的专用连接。
  • Open API 规范不支持多部分媒体类型。
  • 您无法修改自定义连接器的版本详情。