Google 会使用 AI 技术将内容翻译成您偏好的语言。AI 翻译可能包含错误。

Confluence

借助 Confluence 连接器，您可以对 Confluence 执行插入、删除、更新和读取操作。

准备工作

在使用 Confluence 连接器之前，请先完成以下任务：

在您的 Google Cloud 项目中：
- 确保已设置网络连接。如需了解网络模式，请参阅网络连接。
- 向配置连接器的用户授予 roles/connectors.admin IAM 角色。
- 将以下 IAM 角色授予您要用其来使用连接器的服务帐号：
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  服务账号是一种特殊类型的 Google 账号，用于表示需要验证身份并获得授权以访问 Google API 数据的非人类用户。如果您没有服务帐号，则必须创建一个服务帐号。连接器和服务帐号必须属于同一项目。如需了解详情，请参阅创建服务账号。
- 启用以下服务：
  - secretmanager.googleapis.com (Secret Manager API)
  - connectors.googleapis.com (Connectors API)
  如需了解如何启用服务，请参阅启用服务。
如果之前没有为您的项目启用这些服务或权限，则在您配置连接器时，系统会提示您启用。

配置连接器

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

在 Cloud 控制台中，进入 Integration Connectors > 连接 页面，然后选择或创建一个 Google Cloud 项目。
转到“连接”页面
点击 + 新建 以打开创建连接 页面。
在位置部分中，选择连接的位置。
1. 区域：从下拉列表中选择一个位置。
  如需查看所有受支持区域的列表，请参阅位置。
2. 点击下一步 。
在连接详情 部分中，完成以下操作：
1. 连接器：从可用连接器的下拉列表中选择 Confluence 。
2. 连接器版本：从可用版本的下拉列表中选择一个连接器版本。
3. 在连接名称 字段中，输入连接实例的名称。
  连接名称必须符合以下条件：
  - 连接名称可以使用字母、数字或连字符。
  - 字母必须小写。
  - 连接名称必须以字母开头，以字母或数字结尾。
  - 连接名称不得超过 49 个字符。
4. （可选）输入连接实例的说明。
5. （可选）启用 Cloud Logging ，然后选择日志级别。默认情况下，日志级别设置为 Error。
6. 服务账号：选择具有所需角色的服务帐号。
7. （可选）选择包含已归档的空间，以在结果中包含已归档空间的内容。默认值为 false。
8. （可选）输入空间键 以进行搜索，以便仅显示此特定空间。
9. （可选）配置连接节点设置：
  - 节点数下限：输入连接节点数下限。
  - 节点数上限：输入连接节点数上限。
  节点是处理事务的连接单元（或副本）。连接处理越多事务就需要越多节点，相反，处理越少事务需要越少节点。如需了解节点如何影响连接器价格，请参阅连接节点的价格。如果未输入任何值，则默认情况下节点数下限设置为 2（以便提高可用性），节点数上限设置为 50。
10. （可选）在高级设置 部分中，选中使用代理 复选框可为连接配置代理服务器并配置以下值：
11. （可选）点击 + 添加标签 ，以键值对的形式为连接添加标签。
12. 点击下一步 。
在目标部分中，输入要连接到的远程主机（后端系统）的详细信息。
1. 目标类型：选择目标类型。
  - 如需指定目标主机名或 IP 地址，请选择 主机地址 ，然后在 host 1 字段中输入地址。
  - 如需建立专用连接，请选择端点连接 。在 端点连接 列表中，选择为后端系统创建的端点连接。
  如果要与后端系统建立公共连接以提高安全性，您可以考虑为连接配置静态出站 IP 地址，然后将防火墙规则配置为仅将特定静态 IP 地址列入许可名单。
  
  要输入其他目标，请点击 +添加目标 。
2. 点击下一步 。
在身份验证 部分中，输入身份验证详细信息。
1. 选择身份验证类型，然后输入相关详细信息。
  Confluence 连接器支持以下身份验证类型：
  - 基本
  - APIToken
  - OAuth2.0
2. 点击下一步 。
查看：查看您的连接和身份验证详细信息。
点击创建。

配置身份验证

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

基本
- 用户名：用于进行身份验证的 Confluence 用户账号。
- 密码：与账号关联的密码。
APIToken
- 用户名：用于创建 API 令牌的 Confluence 用户名。
- API 令牌：用户名的密码是 API 令牌。选择包含与 Confluence 用户名关联的 API 令牌的 Secret Manager 密文。
OAuth 2.0 - 授权代码
- 客户端 ID ：由外部应用提供的客户端 ID。
- 范围： 所需的最低权限范围取决于您使用的是 Confluence 的传统范围还是精细范围：
  - 传统范围：search:confluence 和 offline_access
  - 精细范围：read:content-details:confluence 和 offline_access
  此外，还需添加应用所需的任何范围。如需详细了解 Confluence 范围，请参阅 Confluence 范围。
- 客户端密钥： 选择 Secret Manager 密钥。您应该先创建 Secret Manager 密钥，然后再配置此授权。
- 密钥版本 ：客户端密钥的 Secret Manager 密钥版本。

创建连接后的其他步骤

如果您为身份验证选择了 OAuth 2.0 - Authorization code，则必须在创建连接后执行以下额外步骤：

在“连接”页面中，找到新创建的连接。
请注意，新连接器的状态将为需要授权 。
点击需要授权 。
此时将显示修改授权 窗格。
将重定向 URI 值复制到外部应用。
验证授权详细信息。
点击授权。
如果授权成功，连接状态将在 “连接”页面中设置为活跃。

授权代码的重新授权

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

在“连接”页面中，点击所需的连接。
系统随即会打开连接详情页面。
点击修改以修改连接详情。
在身份验证 部分中，验证 OAuth 2.0 - 授权代码 详细信息。
如有必要，请进行必要的更改。
点击保存。您随即会进入连接详情页面。
在身份验证 部分中，点击修改授权 。此时将显示授权窗格。
点击授权。
如果授权成功，连接状态将在“连接”页面中设置为活跃。

系统限制

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

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

在集成中使用 Confluence 连接

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

如需了解如何在 Apigee Integration 中创建和使用连接器任务，请参阅连接器任务。
如需了解如何在 Application Integration 中创建和使用连接器任务，请参阅连接器任务。

实体、操作和动作

所有集成连接器都会为所连接应用的对象提供抽象层。您只能通过此抽象访问应用的对象。抽象作为实体、操作和动作向您展示。

实体：实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如，在数据库连接器中，表是实体；在文件服务器连接器中，文件夹是实体；在消息传递系统连接器中，队列是实体。
但可能的情况是，连接器不支持或不具有任何实体，在这种情况下， Entities 列表将为空。
操作：操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作：
- 列表
- 获取
- 创建
- 更新
- 删除
从可用列表中选择一个实体，系统会生成该实体可用的操作列表。如需了解操作的详细说明，请参阅连接器任务的实体操作。但是，如果连接器不支持任何实体操作，则此类不受支持的操作不会列在 Operations 列表中。
动作：动作是可通过连接器接口提供给集成的头等函数。动作可让您对一个或多个实体进行更改，并且动作因连接器而异。通常，动作会包含一些输入参数和一个输出参数。但可能的情况是，连接器不支持任何动作，在这种情况下，Actions 列表将为空。

操作

Confluence 连接器提供 DownloadAttachment 和 UploadAttachment 等操作。如需了解如何配置操作，请参阅操作示例。

操作示例

本部分介绍如何在此连接器中执行一些操作。

示例 - 下载附件

在 Configure connector task 对话框中，点击 Actions。
选择 DownloadAttachment 操作，然后点击完成。
在连接器 任务的任务输入 部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
```
  {
    "AttachmentId": "xyz"
  }
```

实体操作示例

示例 - 列出所有请求

此示例列出了 Requests 实体中的所有请求。

在 Configure connector task 对话框中，点击 Entities。
从 Entity 列表中选择“请求”。
选择 LIST 操作，然后点击完成。

示例 - 从特定账号 ID 获取用户

此示例从 Users 实体中获取 AccoundId 为 6035864ce2020c0070b5285b 的用户。

在 Configure connector task 对话框中，点击 Entities。
从 Entity 列表中选择 Users。
选择 LIST 操作，然后点击完成。
在连接器 任务的任务输入 部分中，点击 filterClause ，然后在默认值 字段中输入 AccountId=6035864ce2020c0070b5285b。
其中，AccountId 是 Users 实体的主键值。

示例 - 列出页面

此示例列出了 Pages 实体中的页面。

在 Configure connector task 对话框中，点击 Entities。
从 Entity 列表中选择 Pages。
选择 LIST 操作，然后点击完成。

示例 - 获取页面

此示例从 Pages 实体中获取页面记录。

在 Configure connector task 对话框中，点击 Entities。
从 Entity 列表中选择 Pages。
选择 GET 操作，然后点击完成。
在连接器 任务的任务输入 部分中，点击 entityId ，然后在默认值 字段中输入 123。
其中，123 是资源 Pages 实体的唯一标识符。

示例 - 创建页面

此示例在 Pages 实体中创建页面记录。

在 Configure connector task 对话框中，点击 Entities。
从 Entity 列表中选择 Pages。
选择 CREATE 操作，然后点击完成。

在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value字段中输入类似于以下内容的值：

{
      "SpaceId": "12345",
      "Status": "Current",
      "Title": "FROM XYZ",
      "Storage": "XYZ1234"
    }

Example - Update Pages

This example updates a page record in the Pages entity.

In the Configure connector task dialog, click Entities.

Select Pages from the Entity list.

Select the UPDATE operation, and then click Done.

In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:
```
{
    "Title": "Update abc"
    }
```
在 连接器 任务的 任务输入 部分中，点击 entityId ，然后在 默认值 字段中输入 12345。

如果集成成功，连接器任务的 connectorOutputPayload 字段将包含更新操作的响应。

{
    "Id": 1234
    }

示例 - 删除页面

此示例从 Pages 实体中删除页面。

在 Configure connector task 对话框中，点击 Entities。
从 Entity 列表中选择 Pages。
选择 DELETE 操作，然后点击完成。
在连接器 任务的任务输入 部分中，点击 entityId ，然后在默认值 字段中输入 123。
或者，如果实体具有复合主键，而不是指定 entityId，您可以设置 filterClause。例如，Id='123'。

使用 Terraform 创建连接

您可以使用 Terraform 资源创建新连接。

如需了解如何应用或移除 Terraform 配置，请参阅基本 Terraform 命令。

如需查看用于创建连接的 Terraform 模板示例，请参阅示例模板。

使用 Terraform 创建此连接时，您必须在 Terraform 配置文件中设置以下变量：

参数名称	数据类型	必需	说明
proxy_enabled	BOOLEAN	False	选中此复选框可为连接配置代理服务器。
proxy_auth_scheme	ENUM	False	用于向 ProxyServer 代理进行身份验证的身份验证类型。支持的值包括：BASIC、DIGEST、NONE
proxy_user	STRING	False	用于向 ProxyServer 代理进行身份验证的用户名。
proxy_password	SECRET	False	用于向 ProxyServer 代理进行身份验证的密码。
proxy_ssltype	ENUM	False	连接到 ProxyServer 代理时使用的 SSL 类型。支持的值包括：AUTO、ALWAYS、NEVER、TUNNEL

向 Google Cloud 社区寻求帮助

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

后续步骤

了解如何暂停和恢复连接。
了解如何监控连接器使用情况。
了解如何查看连接器日志。