Jira Cloud

借助 Jira Cloud 连接器，您可以对建模为数据库的 Jira 数据执行插入、删除、更新和读取操作。

支持的版本

Jira Cloud 连接器使用 JIRA Cloud REST API 的版本 2 和 3。这些功能在内部进行管理，您无需进行任何额外配置。

准备工作

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

  • 在您的 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)

      如需了解如何启用服务，请参阅启用服务。

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

配置连接器

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

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

    转到“连接”页面

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

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

    2. 点击下一步。
  4. 在连接详情部分中，完成以下操作：
    1. 连接器：从可用连接器的下拉列表中选择 Jira Cloud。
    2. 连接器版本：从可用版本的下拉列表中选择一个连接器版本。
    3. 在连接名称字段中，输入连接实例的名称。

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

      • 连接名称可以使用字母、数字或连字符。
      • 字母必须小写。
      • 连接名称必须以字母开头，以字母或数字结尾。
      • 连接名称不能超过 49 个字符。
      • 对于支持事件订阅的连接器，连接名称不得以“goog”前缀开头。
    4. （可选）输入连接实例的说明。
    5. 您可以选择启用 Cloud Logging，然后选择日志级别。默认情况下，日志级别设置为 Error。
    6. 服务账号：选择具有所需角色的服务账号。
    7. 如需将连接用于事件订阅，请选择启用事件订阅。选择此选项后，系统会显示以下选项：
      • 启用包含实体和操作的事件订阅：选择此选项可将连接用于事件订阅和连接器操作（实体和操作）。
      • 仅启用事件订阅：选择此选项可仅将连接用于事件订阅。如果您选择此选项，请点击下一步，然后配置事件订阅。
    8. （可选）配置连接节点设置：

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

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

    9. （可选）在高级设置部分，选中使用代理复选框可为连接配置代理服务器并配置以下值：
      • 代理身份验证方案：选择要通过代理服务器进行身份验证的身份验证类型。支持以下身份验证类型：
        • 基本：基本 HTTP 身份验证。
        • 摘要：摘要 HTTP 身份验证。
      • 代理用户：用于向代理服务器进行身份验证的用户名。
      • 代理密码：用户密码的 Secret Manager 密文。
      • 代理 SSL 类型：连接到代理服务器时使用的 SSL 类型。支持以下身份验证类型：
        • 自动：默认设置。如果网址是 HTTPS 网址，则使用“隧道”选项。如果网址是 HTTP 网址，则使用“永不”选项。
        • 始终：连接始终启用 SSL。
        • 永不：连接未启用 SSL。
        • 隧道：连接通过隧道代理建立。代理服务器会打开与远程主机的连接，并且流量会流经该代理。
      • 在代理服务器部分中，输入代理服务器的详细信息。
        1. 点击+ 添加目标。
        2. 选择目标类型。
          • 主机地址：指定目标的主机名或 IP 地址。

            如果要与后端系统建立专用连接，请执行以下操作：

    10. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
    11. 点击下一步。
  5. 在目标部分中，输入要连接到的远程主机（后端系统）的详细信息。
    1. 目标类型：选择目标类型。
      • 主机地址：指定目标的主机名或 IP 地址。

        如果您想与后端建立专用连接，请执行以下操作：

      要输入其他目标，请点击 + 添加目标。

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

      Jira Cloud 连接支持以下身份验证类型：

      • 用户名和密码

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

    2. 点击下一步。
  7. 如果您已启用事件订阅，连接创建页面上会显示事件订阅详情部分。如需了解如何配置事件订阅详细信息，请参阅配置事件订阅。
  8. 查看：查看您的连接和身份验证详细信息。
  9. 点击创建。

配置事件订阅

如果您已启用事件订阅，请在事件订阅详细信息部分中输入以下值：

  1. 选择目标类型。
    • 主机地址：在主机字段中输入后端系统的注册网址。
  2. 输入身份验证详细信息。
    1. 用户名：输入用户名。
    2. API 令牌：选择包含 API 令牌的 Secret Manager Secret。
    3. 密钥版本：选择密钥版本。
  3. 选择启用专用连接，以在后端应用与连接之间建立安全连接。如果您选择此选项，则必须在创建连接后执行额外的配置步骤。如需了解详情，请参阅活动订阅的专用连接。
  4. 输入死信配置。如果您配置了死信，连接会将未处理的事件写入指定的 Pub/Sub 主题。输入以下详细信息：
    1. 死信项目 ID： 您已配置死信 Pub/Sub 主题的 Google Cloud 项目 ID。
    2. 死信主题： 您要将未处理事件的详细信息写入到的 Pub/Sub 主题。
  5. 如果您想使用代理连接到后端（用于订阅活动），请输入以下详细信息：
    1. 代理 SSL 类型：连接到代理服务器时使用的 SSL 类型。选择以下任一身份验证类型：
      • 始终：连接始终启用 SSL 以进行事件订阅。
      • 永不：连接未针对事件订阅启用 SSL。
    2. 代理身份验证方案：选择要通过代理服务器进行身份验证的身份验证类型。 支持以下身份验证类型：
      • 基本：基本 HTTP 身份验证。
    3. 代理用户：输入用于向代理服务器进行身份验证的用户名。
    4. 代理密码：选择用户密码的 Secret Manager 密文。
    5. 密文版本：选择密文版本。
    6. 在代理服务器部分中，输入代理服务器的详细信息。
      1. 点击 + 添加目标，然后选择目标类型作为主机地址。
      2. 输入代理服务器的主机名或 IP 地址，以及代理服务器的端口号。

配置身份验证

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

  • 用户名和密码
    • 用户名：用于连接的 Jira Cloud 用户名。
    • API 令牌：用户名的密码将是 API 令牌。选择包含与 Jira Cloud 用户名关联的 API 令牌的 Secret Manager Secret。
  • OAuth 2.0 - 授权代码
    • 客户端 ID：由外部应用提供的客户端 ID。
    • 范围：权限范围。必须提供 offline_access 和 read:jira-user 范围才能创建连接。如需了解范围的工作方式并查看 Jira Cloud 的所有可用范围，请参阅范围。
    • 客户端密钥：选择 Secret Manager 密钥。您应该先创建 Secret Manager 密钥，然后再配置此授权。
    • 密钥版本：客户端密钥的 Secret Manager 密钥版本。
    • Cloud ID：指定 Atlassian 网站的 Cloud ID。如需了解如何获取 Cloud ID，请参阅 Cloud ID。

    对于 Authorization code 身份验证类型，创建连接后，您应执行一些额外的步骤来配置身份验证。如需了解详情，请参阅创建连接后的其他步骤。

创建连接后的其他步骤

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

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

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

  2. 点击需要授权。

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

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

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

授权代码的重新授权

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

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

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

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

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

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

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

系统限制

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

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

实体操作示例

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

示例 - 列出问题

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择“问题”。
  3. 选择 LIST 操作，然后点击完成。
  4. 连接器任务的任务输入部分中，您可以根据客户要求设置 filterClause。

    5. 您必须使用英文单引号 (') 将 filterClause 的值括起来，例如 CreatorEmail = 'cruz@altostrat.com'。 您可以使用 filterClause 根据列过滤记录。

    在某些实体中，只有 List 操作无法提取数据。在此类实体中，您可以使用 filetClause。

示例 - 获取问题

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择“问题”。
  3. 选择 GET 操作，然后点击完成。
  4. 将实体 ID 设置为 10000，这是要为问题传递的密钥 ID。如需设置实体 ID，请在连接器任务的任务输入部分，点击 EntityId，然后在默认值字段中输入 10000。

    5. 实体 ID 的值必须直接传递，例如 10000。其中，10000 是唯一的主键值。 Get 操作只能对具有唯一主键的实体执行。

示例 - 删除问题

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择“问题”。
  3. 选择 DELETE 操作，然后点击完成。
  4. 将实体 ID 设置为 10000，即要传递的键。如需设置实体 ID，请在连接器任务的任务输入部分，点击 EntityId，然后在默认值字段中输入 10000。

    5. Delete 操作只能对具有唯一主键的实体执行。

示例 - 创建 IssueType

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 IssueTypes。
  3. 选择 Create 操作，然后点击完成。
  4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
    {
  "Name": "task123456",
  "Description": "New description is added."
}

    如果集成成功，连接器任务的 connectorOutputPayload 响应形参将具有类似以下的值：

    {
  "Id": "10041"
}

示例 - 创建问题

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择“问题”。
  3. 选择 Create 操作，然后点击完成。
  4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
      {
    "IssueTypeName": "Subtask", 
    "ProjectName": "kanban4", 
    "Summary": "Summary Added", 
    "ParentKey": "KN-6" 
  }

    如果集成成功，连接器任务的 connectorOutputPayload 响应形参将具有类似以下的值：

    {
  "Id": 10071.0
}

示例 - 创建冲刺

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择“冲刺跑”。
  3. 选择 Create 操作，然后点击完成。
  4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
    {
  "Name": "PROJ Sprint GCPcloud",
  "State": "future",
  "Goal": null,
  "OriginBoardId": 2.0,
  "StartDate": "2023-06-27 07:06:08",
  "EndDate": "2023-07-27 07:06:08"
}

    如果集成成功，连接器任务的 connectorOutputPayload 响应形参将具有类似以下的值：

    {
  "Id": 23.0
}

示例 - 创建评论

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择“评论”。
  3. 选择 Create 操作，然后点击完成。
  4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
    {
  "IssueId": 10001.0,
  "Body": "Adding comments to above ID by editing it"
}

    如果集成成功，连接器任务的 connectorOutputPayload 响应形参将具有类似以下的值：

    {
  "Id": 10023.0,
  "IssueId": null
}

示例 - 创建用户

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择“用户”。
  3. 选择 Create 操作，然后点击完成。
  4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
    {
  "GroupName": null,
  "DisplayName": "Charlie",
  "EmailAddress": "charlie@altostrat.com",
  "Active": true,
  "TimeZone": null,
  "Locale": "en_US",
  "AccountType": "atlassian"
}

    如果集成成功，连接器任务的 connectorOutputPayload 响应形参将具有类似以下的值：

    {
  "AccountId": "557058:0a04612c-746d-4d47-a909-71ba797fe228"
}

示例 - 创建工作日志

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择“工作日志”。
  3. 选择 Create 操作，然后点击完成。
  4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
    {
  "IssueKey": "GJCT-1",
  "Started": "2023-06-10 08:08:08",
  "TimeSpent": "2000"
}

    如果集成成功，连接器任务的 connectorOutputPayload 响应形参将具有类似以下的值：

    {
  "Id": "41718",
  "IssueId": 10000.0
}

示例 - 更新 IssueTypes

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择 IssueTypes。
  3. 选择 Update 操作，然后点击完成。
  4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
    {
  "Name": "NEW_TASK",
  "Description": "New Description"
}
  5. 将实体 ID 设置为 IssueTypes 的实体。如需设置实体 ID，请点击 entityId，然后在默认值字段中输入 10038。

    如果集成成功，连接器任务的 connectorOutputPayload 响应形参将具有类似以下的值：

    {
  "Id": "10038"
}

示例 - 更新问题

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择“问题”。
  3. 选择 Update 操作，然后点击完成。
  4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
    {
  "AssigneeAccountId": "61d572aa7c6f9800705289a1",
  "AssigneeName": "Charlie c"
}
  5. 将实体 ID 设置为问题的实体。如需设置实体 ID，请点击 entityId，然后在默认值字段中输入 10024。

    如果集成成功，连接器任务的 connectorOutputPayload 响应形参将具有类似以下的值：

    {
  "AssigneeDisplayName": "Charlie Cruz"
}

示例 - 更新冲刺

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择“冲刺跑”。
  3. 选择 Update 操作，然后点击完成。
  4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
    {
  "Name": "PROJ Sprint GCP_Updated",
  "State": "future",
  "StartDate": "2023-06-27 07:06:08",
  "EndDate": "2023-07-27 07:06:08"
}
  5. 将实体 ID 设置为冲刺的实体。如需设置实体 ID，请点击 entityId，然后在默认值字段中输入 2 。

    如果集成成功，连接器任务的 connectorOutputPayload 响应形参将具有类似以下的值：

    {
}

示例 - 更新注释

  1. 在 Configure connector task 对话框中，点击 Entities。
  2. 从 Entity 列表中选择“评论”。
  3. 选择 Update 操作，然后点击完成。
  4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
    {
  "Name": "PROJ Sprint GCPcloud_Updated",
  "State": "future",
  "StartDate": "2023-06-27 07:06:08",
  "EndDate": "2023-07-27 07:06:08"
}
  5. 将实体 ID 设置为评论的实体。如需设置实体 ID，请点击 entityId，然后在默认值字段中输入 2。

    如果集成成功，连接器任务的 connectorOutputPayload 响应形参将具有类似以下的值：

    {
}

使用 Terraform 创建连接

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

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

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

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

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

在集成中使用 Jira Cloud 连接

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

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

向 Google Cloud 社区寻求帮助

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

后续步骤