本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# Atlassian Confluence 云操作集成
<a name="confluence-action-integration"></a>

使用 Atlassian Confluence Cloud 操作连接器，通过自然语言直接在 Amazon Quick 中创建、更新和管理 Confluence 页面和空间。

要设置此集成，您需要先在 Atlassian 开发者控制台中创建 OAuth 2.0 (3LO) 应用程序并配置其权限。然后，您可以在 Amazon Quick 中创建集成并将其连接到您的 Atlassian 应用程序。有关 Amazon Quick 支持的身份验证方法的信息，请参阅[身份验证方法](quick-action-auth.md)。

## 开始前的准备工作
<a name="confluence-action-prerequisites"></a>

在设置集成之前，请确保您具备以下条件。
+ Atlassian 融合云。
+ 访问 [Atlassian 开发者控制台](https://developer.atlassian.com/console/myapps/)以创建或管理应用程序。 OAuth 
+ 有关订阅要求，请参阅[在控制台中设置集成](integration-console-setup-process.md)。

## 配置 Atlassian 开发者控制台
<a name="confluence-action-atlassian-setup"></a>

如果您计划使用用户身份验证 (3LO)，请在配置 Amazon Quick 之前在 Atlassian 开发者控制台中创建 OAuth 2.0 应用程序。在移至 Amazon Quick 控制台之前，请完成以下所有步骤。

如果您计划仅使用服务身份验证（API 密钥），则可以跳过本节继续操作[准备身份验证](#confluence-action-auth-setup)。

有关 OAuth 2.0 (3LO) 应用程序的更多信息，请参阅 Atlassian 开发者文档中的 [OAuth 2.0 (3LO) 应用程序](https://developer.atlassian.com/cloud/confluence/oauth-2-3lo-apps/)。

### 创建一个 OAuth 2.0 (3LO) 应用程序
<a name="atlassian-oauth-app"></a>

Amazon Quick 使用 Atlassian OAuth 2.0 (3LO) 应用程序代表您的用户使用您的 Atlassian Cloud 产品进行身份验证。在配置 Amazon Quick 之前，请在 Atlassian 开发者控制台中创建此应用程序。

1. 打开 [Atlassian 开发者控制台](https://developer.atlassian.com/console/myapps/)，然后使用您的 Atlassian 账户登录。

1. 选择 “**创建**”，然后选择 **OAuth 2.0 集成**。

1. 例如`your-app-name connector`，在**名称**中输入集成的描述性名称。

1. 查看并接受 Atlassian 开发者条款。

1. 选择**创建**。

### 配置 权限
<a name="atlassian-oauth-permissions"></a>

创建 OAuth 2.0 应用程序后，添加 Amazon Quick 与你的 Atlassian 产品交互所需的 API 权限。

1. 在 Atlassian 开发者控制台中的应用程序中，选择左侧**导航栏中的权限**。

1. **找到适用于你的 Atlassian 产品的 API（例如 **Jira API 或 **Confluence** API**），然后选择添加。**添加 API 后，按钮将变为 “**配置**”。

1. 选择**配置**。范围页面打开时会显示**经典作用域**和**精细范围**选项卡。

1. 在 “**经典范围**” 选项卡上，选择 **“编辑范围”**。选择所需的经典示波器，然后选择 “**保存**”。

1. 选择 “**精细范围**” 选项卡，然后选择 “**编辑范围”**。选择所需的粒度范围，然后选择 “**保存**”。

有关集成所需的特定范围，请参阅后面的作用域部分。

### Confluence 所需的范围
<a name="confluence-action-oauth-scopes"></a>

在 Confluence Cloud 操作集成的 OAuth 2.0 应用程序中添加以下范围。

**经典瞄准镜**

在 “**经典范围**” 选项卡上，选择 **“编辑范围**”，然后选择以下范围。


**Confluence 动作集成 — 经典范围**  

| Scope | 说明 | 
| --- | --- | 
| search:confluence | 搜索 Confluence 内容和空间摘要。 | 

**精细瞄准镜**

选择 “**精细范围**” 选项卡，然后选择 “**编辑范围”**。选择以下范围。


**Confluence 操作集成 — 精细范围**  

| Scope | 说明 | 
| --- | --- | 
| read:page:confluence | 查看页面内容。 | 
| write:page:confluence | 创建和更新页面。 | 
| read:space:confluence | 访问空间信息。 | 

### 配置授权
<a name="atlassian-oauth-authorization"></a>

设置回传网址，以便 Atlassian 可以在用户授权应用程序后将其重定向回 Amazon Quick。

1. 在 Atlassian 开发者控制台中的应用程序中，选择左侧**导航栏中的授权**。

1. 在 **OAuth 2.0 (3LO)** 旁边，选择**添加**。

1. 在 “**回叫**” URLs 中，输入`https://region.quicksight.aws.amazon.com/sn/oauthcallback`。例如，*region*替换为部署您的 Amazon Quick 实例的 AWS 区域`us-east-1`。

1. 选择**保存更改**。

### 记录您的凭证
<a name="atlassian-oauth-credentials"></a>

在离开 Atlassian 开发者控制台之前，请确认您具有以下值。您需要它们来配置 Amazon Quick。

1. 在 Atlassian 开发者控制台中的应用程序中，选择左侧**导航栏中的设置**。

1. 在 “**身份验证详细信息**” 下，复制 “**客户端 ID**” 和 “**密钥**” 值。


**来自 Atlassian 开发者控制台的所需凭证**  

| 值 | 在哪里可以找到它 | 
| --- | --- | 
| 客户端 ID | 设置页面，在 “身份验证详情” 下 | 
| Secret | 设置页面，在 “身份验证详情” 下 | 

## 准备身份验证
<a name="confluence-action-auth-setup"></a>

Confluence Cloud 操作连接器支持两种身份验证方法。在配置 Amazon Quick 之前，请收集所需的凭证。

**用户身份验证 (3LO)**  
如果您在上一节中完成了 Atlassian 开发者控制台的设置，则应准备好以下值。在 Amazon Quick 中配置集成时，请输入这些信息。  
+ **基本网址** — 用于调用 API 的 Confluence 实例网址。这与用户登录的 URL 不同。它类似于以下内容:`https://api.atlassian.com/ex/confluence/yourInstanceId`. 要查找您的实例 ID，请导航至`https://your-domain.atlassian.net/_edge/tenant_info`。
+ **客户端 ID** — 来自您的 Atlassian 应用程序的 “设置” 页面。 OAuth 
+ **客户密钥**-来自您的 Atlassian 应用程序的 “设置” 页面。 OAuth 
+ **代币网址** — `https://auth.atlassian.com/oauth/token`
+ **授权网址** — `https://auth.atlassian.com/authorize`
+ **重定向网址** — `https://region.quicksight.aws.amazon.com/sn/oauthcallback`

**服务认证（API 密钥）**  
从您的 Confluence 云管理员那里收集以下信息：  
+ **API 密钥** — Confluence API 令牌。
+ **基本网址** — 用于调用 API 的 Confluence 实例网址。
+ **电子邮件**-关联用户帐户电子邮件。

## 在 Amazon Quick 中设置集成
<a name="confluence-action-integration-setup"></a>

准备好身份验证凭证后，在 Amazon Quick 中创建集成。

1. 在 Amazon Quick 控制台中，选择**集成。**

1. 选择**操作**选项卡。

1. 在 “**为操作设置新的应用程序集成**” 下，找到 **Atlassian Confluence Cloud**，然后选择添加（加上 “\$1”）按钮。

1. **在**集成类型**页面上，选择在 **Atlassian Confluence Cloud 中执行操作**，然后选择下一步。**

1. 在**创建集成**表单中，填写以下字段：
   + **名称**-您的 Confluence 集成的描述性名称。
   + **描述**（可选）-有关如何使用此连接的说明。
   + **连接类型**-选择**公共网络**。

1. 在 **“身份验证设置”** 下，选择您的身份验证方法并填写必填字段：

   1. 对于**用户身份验证**，请配置以下字段：
      + **基本网址** — 您用于 API 调用的 Confluence 实例网址，格式为。`https://api.atlassian.com/ex/confluence/yourInstanceId`要查找您的实例 ID，请导航至`https://your-domain.atlassian.net/_edge/tenant_info`。
      + **客户端 ID** — 来自 Atlassian 应用程序的 “设置” 页面的客户端 ID。 OAuth 
      + **客户密钥**-来自 Atlassian 应用程序的 “设置” 页面的密钥。 OAuth 
      + **代币网址** — `https://auth.atlassian.com/oauth/token`
      + **授权网址** — `https://auth.atlassian.com/authorize`
      + **重定向 URL** — 此字段已预先填充您的 Amazon Quick 回传网址。

   1. 对于**服务身份验证**，请配置以下字段：
      + **API 密钥** — Confluence API 令牌。
      + **基本网址** — 用于调用 API 的 Confluence 实例网址。
      + **电子邮件**-关联用户帐户电子邮件。

1. 选择**创建并继续**。

1. （可选）在**共享集成**页面上，选择要与之共享集成的用户。

## 可用操作
<a name="confluence-action-available-actions"></a>

设置集成后，可以执行以下操作。


**融合云的可用操作**  

| Action | 说明 | 
| --- | --- | 
| 创建页面 | 创建新页面。 | 
| 获取页面 | 查看所有页面。 | 
| Search | 使用 CQL 搜索内容。 | 
| 更新页面 | 更新页面内容。 | 

## 管理和故障排除
<a name="confluence-action-troubleshooting"></a>

要编辑、共享或删除您的集成，请参阅[管理现有集成](integration-workflows.md#managing-existing-integrations)。

### 身份验证问题
<a name="confluence-action-troubleshooting-auth"></a>
+ **应用程序配置不正确**-验证 Atlassian 开发者控制台中的 OAuth 应用程序是否包含所需的范围，并且重定向 URI 是否与您的 Amazon Quick 配置相匹配。
+ **API 令牌已过期** — 如果使用服务身份验证，请检查 API 令牌是否未过期，并在需要时生成一个新令牌。
+ **基本网址不正确** — API 调用的基本网址与 Confluence Cloud 登录网址不同。确认您使用的是 API 网址格式：`https://api.atlassian.com/ex/confluence/yourInstanceId`。要查找您的实例 ID，请导航至`https://your-domain.atlassian.net/_edge/tenant_info`。

### 常见错误消息
<a name="confluence-action-troubleshooting-errors"></a>
+ **`Access denied. You do not have permission to perform this action`**— 经过身份验证的用户在 Confluence Cloud 中没有所需的权限。请联系您的 Confluence 云管理员以验证并授予相应的权限。
+ **`OAuth 2.0 authorization failed`**— 验证在 Atlassian 开发者控制台和 Amazon Quick 中是否正确配置了客户端 ID、客户端密钥和 OAuth 范围。