创建自定义连接器

控制台

1. 在控制台中，前往 Integration Connectors > 自定义连接器页面，然后选择或创建 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"
   

请替换以下内容：

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

控制台

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

   前往“自定义连接器”页面

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

   无法在 Integration Connectors 中配置从中间服务到后端的身份验证配置；中间服务如何与后端进行身份验证取决于中间服务本身。

   您可以使用以下身份验证类型向中介服务进行身份验证：

   • 服务账号身份验证
   • API 密钥身份验证
   • OAuth 2.0 - 客户端凭据身份验证
   • 基本身份验证
   • 摘要式身份验证

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

   如果对 API 资源的访问不受限制，并且不需要任何身份验证，请选择 No Authentication（无身份验证）。

10. 点击下一步。
11. 在后端变量部分，输入您要通过中介服务发送到后端的值。您必须将值配置为键值对。如需输入键值对，请点击添加变量，然后设置以下字段：
    • 密钥：输入密钥名称。
    • 值类型：选择变量的数据类型。
    • 显示名称：输入显示名称。
    • 位置：指定您希望连接器如何将变量发送到中介服务。可用的选项包括：Header、Request payload 和 Query parameter。
    • （可选）选择 Required 以指定该变量为必需变量。
12. 点击下一步。
13. 查看连接器配置详情，然后点击创建。

如果连接器创建成功，新创建的连接器将显示在自定义连接器页面中；如果它是新连接器，系统还会创建该连接器的第一个版本。您可以在自定义连接器详细信息页面的版本标签页中查看版本详细信息。如需了解如何创建和修改自定义连接器版本，请参阅管理自定义连接器版本。

不过，请注意，如需连接到后端，您必须为新创建的连接器创建连接。如需了解详情，请参阅创建自定义连接器连接。

配置身份验证

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

• 服务账号身份验证

  选择此选项可使用 Google Cloud 服务账号进行身份验证。确保您已为服务账号提供身份验证所需的相应 IAM 角色和权限。

  • 范围：从下拉菜单中选择所需的 OAuth 2.0 范围。如需了解详情，请参阅访问权限范围。
• API 密钥身份验证

  选择此选项可使用 API 密钥进行身份验证。

  • API 密钥：选择 API 密钥的 Secret Manager Secret。
  • 密文版本：选择密文版本。
  • API 密钥参数名称：输入 API 密钥的参数名称。API 密钥以键值对的形式发送到您的后端服务器。您在此处输入的值将用作您之前选择的 API 密钥的密钥名称。
  • API 密钥位置：选择要在请求中添加 API 密钥的位置。
• OAuth 2.0 - 客户端凭据授予
  • 客户端 ID：用于向中介服务进行身份验证的客户端 ID。
  • 客户端密钥：包含用于向中介服务进行身份验证的客户端密钥的 Secret Manager Secret。
  • 访问令牌的请求格式：在从身份验证服务器提取访问令牌的请求中使用的请求格式。 选择 body 以将客户端 ID 和 Secret 作为请求正文传递，或选择 header 以将它们作为编码标头传递。
  • 令牌请求路径：要附加到身份验证服务器网址以提取访问令牌网址的请求路径。
• 基本身份验证
  • 用户名：用于向中介服务进行身份验证的用户名。
  • 密码：包含与提供的用户名关联的密码的 Secret Manager Secret。
• 摘要身份验证
  • 用户名：用于向中介服务进行身份验证的用户名。
  • 密码：包含与提供的用户名关联的密码的 Secret Manager Secret。

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"
   

请替换以下内容：

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