请参阅 Application Integration 支持的连接器。
Jira Cloud 触发器
Jira Cloud 触发器是一种连接器事件触发器,可让您根据您在 Jira Cloud 连接中订阅的 Jira Cloud 事件调用集成。
准备工作
如果您打算为 Jira Cloud 触发器创建或配置新连接,请确保您拥有项目的以下 IAM 角色:
- 连接器管理员 (
roles/connectors.admin
)
如需了解如何授予角色,请参阅管理访问权限。
向要用于 Jira Cloud 触发器的服务帐号授予以下 IAM 角色:
- Application Integration 调用方 (
roles/integrations.integrationInvoker
)
如需了解如何向服务账号授予角色,请参阅管理对服务账号的访问权限。
添加 Jira Cloud 触发器
如需将 Jira Cloud 触发器添加到您的集成,请执行以下步骤:
- 在 Google Cloud 控制台中,前往 Application Integration 页面。
- 在导航菜单中,点击 Integrations(集成)
此时将显示集成列表页面,其中列出了 Google Cloud 项目中提供的所有集成。
- 选择现有集成,或点击创建集成以创建新集成。
要创建新的集成,请执行以下操作:
- 在 Create Integration(创建集成)窗格中输入名称和说明。
- 选择集成区域。
- 为集成选择服务帐号。您随时可以在集成工具栏的 集成摘要窗格中更改或更新集成的服务帐号详细信息。
- 点击创建。
系统会在集成编辑器中打开集成。
- 在集成编辑器导航栏中,点击触发器以查看可用触发器的列表。
- 点击 Jira Cloud 触发器元素并将其放置在集成编辑器中。
如需配置 Jira Cloud 触发器,您可以使用 Integration Connectors 中提供的现有 Jira Cloud 连接,或者使用内嵌连接创建选项创建新的 Jira Cloud 连接。
使用现有连接配置 Jira Cloud 触发器
您可以使用 Integration Connectors 中的现有 Jira Cloud 连接配置 Jira Cloud 触发器。请注意,Jira Cloud 触发器是一种连接器事件触发器,因此您只能使用启用了事件订阅的 Jira Cloud 连接来配置触发器。
如需了解如何使用新的 Jira Cloud 连接配置 Jira Cloud 触发器,请参阅使用新连接配置 Jira Cloud 触发器
如需使用现有 Jira Cloud 连接配置 Jira Cloud 触发器,请执行以下步骤:
- 点击集成编辑器中的 Jira Cloud 触发器元素,打开触发器配置窗格。
- 点击配置触发器。
- 在连接器事件触发器编辑器页面提供以下配置详细信息:
- 点击完成,完成触发器配置并关闭页面。
使用新连接配置 Jira Cloud 触发器
如需使用新的 Jira Cloud 连接配置 Jira Cloud 触发器,请执行以下步骤:
- 点击集成编辑器中的 Jira Cloud 触发器元素,打开触发器配置窗格。
- 点击配置触发器。
- 跳过区域字段。
- 点击连接,然后从下拉菜单中选择创建连接选项。
- 在创建连接窗格中完成以下步骤:
- 在位置步骤中,选择新的 Jira Cloud 连接的位置:
- 区域:从下拉列表中选择一个区域。
- 点击下一步。
- 在 Connection Details 步骤中,提供新 Jira Cloud 连接的详细信息:
- 连接器版本:从下拉列表中选择可用的 Jira Cloud 连接器版本。
- Connection Name:输入 Jira Cloud 连接的名称。
- (可选)说明 :输入连接说明。
- (可选)启用 Cloud Logging:选中此复选框可存储连接的所有日志数据。
- 服务帐号:选择具有 Jira Cloud 连接所需 IAM 角色的服务帐号。
- 启用事件订阅:选择为 Jira Cloud 连接创建和启用新的事件订阅。您可以仅启用事件订阅,也可以将连接实体、操作和操作包含在内。
- (可选)展开高级设置以配置连接节点设置。
如需详细了解 Jira Cloud 的连接节点设置,请参阅 Jira Cloud 连接文档。
- (可选)点击 + 添加标签,以键值对的形式为连接添加标签。
- 点击下一步。
-
在目标用户步骤中,提供 Jira Cloud 帐号的详细信息:
- 目标类型:选择主机地址。
- 主机:输入您的 Jira Cloud 帐号的主机名或 IP 地址。
- 点击下一步。
-
在身份验证步骤中,提供 Jira Cloud 帐号的身份验证详细信息:
- 用户名:输入用户名以访问所提供的目标地址。
- API 令牌:选择包含与 Jira Cloud 用户名关联的 API 令牌的 Secret Manager Secret。
- 密钥版本:选择密钥版本。
- 点击下一步。
如需详细了解如何配置身份验证,请参阅配置身份验证。
-
在事件订阅详情步骤中,提供将在其中创建事件订阅的 Jira Cloud 帐号的详细信息。
- 目标类型:选择主机地址。
- Host(主机):输入您的 Jira Cloud 帐号的注册网址。系统将为此网址创建事件订阅。
- 用户名:输入用户名以访问所提供的注册网址。
- API 令牌:选择包含与用户名关联的 API 令牌的 Secret Manager Secret。
- 密钥版本:选择密钥版本。
- 点击下一步。
- 检查:查看提供的 Jira Cloud 连接详细信息。
- 点击创建以完成新 Jira Cloud 连接的创建。
- 在位置步骤中,选择新的 Jira Cloud 连接的位置:
- 事件订阅类型:选择触发集成的事件订阅类型。如需了解此触发器支持的事件订阅类型,请参阅支持的事件订阅类型。
- 点击完成,然后关闭页面。
触发器输出
Jira Cloud 触发器需要几分钟时间才能完成事件订阅配置。您可以在事件订阅详情下的触发器配置窗格中查看事件订阅的状态。
Jira Cloud 触发器使用以下状态来指示事件订阅的状态:
Creating
:表示触发器正在订阅事件订阅。Active
:表示触发器已成功订阅事件订阅。Error
:表示所配置的事件订阅存在问题。
除了事件订阅状态之外,事件订阅详情部分还会显示其他详细信息,例如连接区域、连接名称、事件订阅名称等。
下图显示了 Jira Cloud 触发器配置窗格的示例布局:
触发器输出变量
对于每个事件,Jira Cloud 触发器都会生成一个 ConnectorEventPayload
输出变量,供您在下游任务中使用。输出变量采用 JSON 格式,其中包含输出 Jira Cloud 载荷架构。
查看活动订阅
如需在 Integration Connectors 中查看和管理与连接关联的所有事件订阅,请执行以下操作:
- 转到集成连接器 > 连接页面。
- 点击要查看其订阅的连接。
- 点击活动订阅标签页。
执行此操作后,系统会显示连接的所有事件订阅。
修改 Jira Cloud 触发器
您可以修改 Jira Cloud 触发器,以更改或更新连接配置和事件订阅详情。
如需修改 Jira Cloud 触发器,请执行以下步骤:
- 点击集成编辑器中的 Jira Cloud 触发器元素,打开触发器配置窗格。
- 点击配置 Jira Cloud 触发器。
- 在连接器事件触发器编辑器页面中,执行以下操作:
- 如需保留先前配置的事件订阅,请点击保留,否则请点击删除。
- 根据需要更新连接配置和事件订阅详情。
- 点击完成。
您可以在事件订阅详情下的触发器配置窗格中查看更新后的连接和事件订阅详情。
支持的事件订阅类型
您可以使用 Jira Cloud 触发器针对以下事件订阅类型调用集成:
事件订阅类型 | 说明 |
---|---|
attachment_created
|
系统会为 Jira 工单创建一个连接。 |
attachment_deleted
|
与 Jira 工单关联的附件会被删除。 |
board_created
|
系统会创建一个新的 Jira 面板。 |
board_deleted
|
Jira 开发板被删除。 |
comment_created
|
在 Jira 工单中添加了注释。 |
comment_deleted
|
Jira 工单中的评论已被删除。 |
comment_updated
|
Jira 工单中的现有注释已更新。 |
filter_created
|
系统会创建一个新的 Jira 过滤条件。 |
filter_deleted
|
系统会删除 Jira 过滤条件。 |
filter_updated
|
现有的 Jira 过滤条件已更新。 |
issue_created
|
系统会创建一个新的 Jira 问题。 |
issue_deleted
|
Jira 问题会被删除。 |
issue_updated
|
现有的 Jira 问题已更新。 |
issuelink_created
|
系统会为 Jira 实例创建一个新的问题链接。 |
issuelink_deleted
|
Jira 实例的问题链接已删除。 |
option_issuelinks_changed
|
更改或更新 Jira 实例的现有问题链接。 |
option_subtasks_changed
|
某个问题对应的子任务会进行更新或更改。 |
option_voting_changed
|
Jira 问题的票数会发生变化。 |
option_watching_changed
|
为监控 Jira 问题而添加的观察者或用户列表发生了变化。 |
project_created
|
创建一个新项目。 |
project_deleted
|
系统会删除项目。 |
project_restored_deleted
|
系统会恢复已删除的项目。 |
project_soft_deleted
|
系统会删除项目,使其对任何用户(包括使用产品界面或 API 的管理员)都看不到。 |
project_updated
|
系统会更新项目详细信息。 |
sprint_closed
|
Sprint 结束。 |
sprint_created
|
系统即会创建一个 Sprint。 |
sprint_deleted
|
Sprint 被删除。 |
sprint_updated
|
Sprint 的详细信息会更改或更新。 |
user_created
|
系统创建了一个用户。 |
user_updated
|
更改或更新用户的详细信息。 |
worklog_created
|
添加了一个工作日志条目。 |
worklog_deleted
|
删除了一项工作日志条目。 |
worklog_updated
|
更改或更新工作日志条目。 |