Jira Service Management

借助 Jira Service Management 连接器，您可以连接到 Jira Service Management 并执行插入、删除、更新和读取操作。

准备工作

在使用 Jira Service Management 连接器之前，请执行以下任务：

• 在您的 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. Connector：从可用连接器下拉列表中选择 Jira Service Management。
   2. 连接器版本：从可用版本的下拉列表中选择一个连接器版本。
   3. 在连接名称字段中，输入连接实例的名称。

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

      • 连接名称可以使用字母、数字或连字符。
      • 字母必须小写。
      • 连接名称必须以字母开头，以字母或数字结尾。
      • 连接名称不能超过 49 个字符。
   4. （可选）输入连接实例的说明。
   5. 您可以选择启用 Cloud Logging，然后选择日志级别。默认情况下，日志级别设置为 Error。
   6. 服务账号：选择具有所需角色的服务账号。
   7. 输入已通过身份验证的用户的 Service Desk ID。默认情况下，我们会通过额外调用获取第一个 ID，以获取所有服务台。您可以通过对 ServiceDesks 实体执行列表查询来获取 ServiceDeskId。
   8. 输入连接的详细程度级别，从 1 到 5 不等。详细级别越高，系统会记录的通信详细信息（请求、响应和 SSL 证书）就越多。
   9. （可选）配置连接节点设置：
      • 节点数下限：输入连接节点数下限。
      • 节点数上限：输入连接节点数上限。

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

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

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

          • 创建 PSC 服务连接。
          • 创建端点连接然后在主机地址字段中输入端点连接的详细信息。
   11. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
   12. 点击下一步。
5. 在目标部分中，输入要连接到的远程主机（后端系统）的详细信息。
   1. 目的地类型：选择目的地类型。
      • 从列表中选择主机地址，以指定目的地的主机名或 IP 地址。
      • 如果要与后端系统建立专用连接，请从列表中选择端点连接，然后从端点连接列表中选择所需的端点连接。
        注意：如需了解如何创建端点连接，请参阅 PSC 服务连接和端点连接。创建端点连接后，它将显示在端点连接列表中。

      如果要与后端系统建立公共连接以提高安全性，您可以考虑为连接配置静态出站 IP 地址，然后将防火墙规则配置为仅将特定静态 IP 地址列入许可名单。

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

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

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

      • OAuth2.0
      • 基本
      • APIToken

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

   2. 点击下一步。
7. 查看：查看您的连接和身份验证详细信息。
8. 点击创建。

配置身份验证

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

• OAuth2.0
  • 客户端 ID：由外部应用提供的客户端 ID。
  • 范围：权限范围。offline_access 范围必须与 Jira Service Management 连接器搭配使用。为了了解 这些范围的运作方式，并查看 Jira Service Management 的所有可用范围， 请参阅范围。
  • 客户端密钥 ：选择 Secret Manager 密钥。 您必须先创建 Secret Manager 密钥，然后再配置此授权。
  • 密钥版本：客户端密钥的 Secret Manager 密钥版本。

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

  注意：如果您使用的是 Authorization code 身份验证 并在 Jira Service Management 应用中更改了配置，那么您必须重新授权 Jira Service Management 连接。如需了解如何重新授权，请参阅 为授权代码重新授权。
• 基本
  • 用户名：用于进行身份验证的 Jira Service Management 用户账号。
  • 密码：与账号关联的密码。
• APIToken
  • 用户名：用于创建 API 令牌的 Jira Service Management 用户名。
  • API 令牌：用户名的密码将是 API 令牌。选择包含与 Jira Cloud 用户名关联的 API 令牌的 Secret Manager 密钥。

创建连接后的其他步骤

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

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

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

2. 点击需要授权。

   此时将显示修改授权窗格。

3. 将重定向 URI 值复制到您的外部应用。
4. 验证授权详情。
5. 点击 Authorize（授权）。

   如果授权成功，“连接”页面中的连接状态将设为活跃。

为授权代码重新授权

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

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

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

2. 点击修改以修改连接详情。
3. 验证 Authentication（身份验证）部分中的 OAuth 2.0 - Authorization code（OAuth 2.0 - 授权代码）详细信息。

   根据需要进行必要的更改。

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

   如果授权成功，“连接”页面中的连接状态将设为活跃。

实体、操作和动作

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

注意：您可以在连接器任务中查看连接器的实体、操作和动作。

• 实体：实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如，在数据库连接器中，表是实体；在文件服务器连接器中，文件夹是实体；在消息传递系统连接器中，队列是实体。

  但是，连接器可能不支持或不支持任何实体，在这种情况下， “Entities”列表将为空。

• 操作：操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作：
  • 列表
  • 获取
  • 创建
  • 更新
  • 删除

  从可用列表中选择一个实体，系统会生成该实体可用的操作列表。如需了解操作的详细说明，请参阅连接器任务的实体操作。但是，如果连接器不支持任何实体操作， 操作未在 Operations 列表中列出。

• 动作：动作是可通过连接器接口提供给集成的头等函数。动作可让您对一个或多个实体进行更改，并且动作因连接器而异。通常，操作有一些输入参数和一个输出 参数。但可能的情况是，连接器不支持任何动作，在这种情况下，Actions 列表将为空。

注意：所有实体和操作都具有与之关联的架构。例如，操作架构将包含以下参数详细信息：参数 及其对应的数据类型。实体和操作的架构（元数据）由连接在运行时从后端提取。如果架构有任何更新，此类更新将不会 会自动体现在您的现有连接中；您必须手动刷新架构如需刷新连接的架构，请打开连接的连接详情页面，然后点击刷新连接架构。

系统限制

Jira Service Management 连接器每秒可以处理 15 个事务， 每节点， 并throttles任何事务 。 默认情况下，Integration Connectors 会为连接分配 2 个节点（以提高可用性）。

如需了解适用于集成连接器的限制，请参阅限制。

注意：Integration Connectors 节点的数量会动态地自动扩缩 根据您的使用情况但是，如果您想为大量存储卷预留容量， 等待自动扩缩，您可以调整连接的最小节点值。更多 节点处理更多连接事务。相反，如果连接处理的事务较少，则需要的节点就越少。如需配置节点值，请执行以下操作：

• 如果您是随用随付客户，请在“修改关联”页面中配置节点的最小值和最大值。
• 如果您是订阅型客户，请与支持团队联系。

节点可处理的最大事务数取决于多种因素。因此，在调整最小节点数以提高吞吐量之前，建议您检查后端系统是否已以最佳方式设置，以处理所需的流量。

操作

Jira Service Managmenet 连接器提供 AddAttachment、AttachTemporaryFile 和 CreateCustomer 等操作。要了解如何配置 操作，请参阅操作示例。

操作示例

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

示例 - 附加临时文件

本示例附加了一个临时文件，并提供用于添加附件的附件 ID。

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 AttachTemporaryFile 操作，然后点击完成。
3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

     {
       "Content": "test to create 1 temporaryid"
     }

如果此操作成功，您的 连接器任务的“connectorOutputPayload”响应 参数的值类似于以下内容：

[{
    "TemporaryAttachmentId": "3ef17ee7-3877-4ac6-b586-481cb2121ef8",
    "FileName": "16324233309516250343.connector.txt"
}] 

示例 - 添加附件

此示例将临时文件附加到输入载荷中提供的请求 ID。

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 AddAttachment 操作，然后点击完成。
3. 在连接器任务的任务输入部分，点击 connectorInputPayload，然后在 Default Value 字段：

   {
       "AttachmentId": "3ef17ee7-3877-4ac6-b586-481cb2121ef8",
       "RequestId": "10032"
   }  

如果此操作成功，您的 连接器任务的“connectorOutputPayload”响应 参数的值类似于以下内容：

[{
  "Success": "true",
  "filename": "16324233309516250343.connector.txt",
}] 

示例 - 创建客户

此示例创建了一位客户。

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 CreateCustomer 操作，然后点击完成。
3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
     "Email": "[e-mail]",
     "FullName": "Something"
   } 

如果操作成功，连接器任务的 connectorOutputPayload 响应参数的值将类似于以下内容：

[{
    "Key": null,
    "AccountId": "qm:476582de-e968-4bc9-b0be-0349e8e3ec97:244dd7e4-0b49-4468-adac-561ab09bf2bb",
    "Name": null,
    "EmailAddress": "[e-mail]",
    "DisplayName": "Something",
    "Active": "true",
    "Timezone": "Asia/Calcutta",
    "_links.jirarest": "https://google-team-zlre6yes.atlassian.net/rest/api/2/user?accountId=qm%3A476582de-e968-4bc9-b0be-0349e8e3ec97%3A244dd7e4-0b49-4468-adac-561ab09bf2bb",
    "_links.avatarurls.48x48": "https://avatar-management.services.atlassian.com/default/48",
    "_links.avatarurls.24x24": "https://avatar-management.services.atlassian.com/default/24",
    "_links.avatarurls.16x16": "https://avatar-management.services.atlassian.com/default/16",
    "_links.avatarurls.32x32": "https://avatar-management.services.atlassian.com/default/32",
    "_links.self": "https://google-team-zlre6yes.atlassian.net/rest/api/2/user?accountId=qm%3A476582de-e968-4bc9-b0be-0349e8e3ec97%3A244dd7e4-0b49-4468-adac-561ab09bf2bb"
}]

实体操作示例

示例 - 列出所有请求

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

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

示例 - 从特定服务中心 ID 获取请求

此示例从 Requests 实体获取请求键为 DP1-14 的请求。

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Requests。
3. 选择 LIST 操作，然后点击 完成。
4. 在连接器任务的任务输入部分，点击 filterClause 并 然后在 Default Value 字段中输入 RequestKey='DP1-14'。

   其中，RequestKey 是 Requests 实体的主键值。

示例 - 创建请求

此示例会在 Requests 实体中创建请求。

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Requests。
3. 选择 Create 操作，然后点击完成。
4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {, , ,) VALUES ('2', '1', '','test');
       "RequestTypeId": "2",
       "ServiceDeskId": "1",
       "Summary": "test",
       "Description": "test"
     }
     

   如果集成成功，您的连接器任务的 connectorOutputPayload 字段将具有类似以下内容的值：

    {
       "RequestId": "10032"
     } 
     

使用 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 Service Management 连接

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

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

向 Google Cloud 社区寻求帮助

您可以在 Google Cloud 中发布问题和讨论此连接器 Cloud 论坛。

后续步骤

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