认证
此提供商需要身份验证。
- api_key: OpsGenie api 密钥(必需:True,敏感:True)
- integration_name: OpsGenie 集成名称(必需:True,敏感:False)
某些范围可能需要才能通过提供商执行特定操作或查询。以下是相关范围及其用例的摘要:
- opsgenie:create: 创建 OpsGenie 警报(强制)
在工作流中
此提供商可用于工作流。
作为"步骤"来查询数据,示例:
yaml
steps:
- name: Query opsgenie
provider: opsgenie
config: "{{ provider.my_provider_name }}"
with:
query_type: {value}
query: {value}作为"操作"来进行更改或更新数据,示例:
yaml
actions:
- name: Query opsgenie
provider: opsgenie
config: "{{ provider.my_provider_name }}"
with:
user: {value} # 请求所有者的显示名称
note: {value} # 创建警报时添加的附加备注
source: {value} # 警报的来源字段。默认值是传入请求的 IP 地址
message: {value} # 警报的消息
alias: {value} # 警报的客户端定义标识符,也是警报去重的关键元素
description: {value} # 警报的描述字段,通常用于提供详细信息
responders: {value} # 警报将被路由到的响应者以发送通知
visible_to: {value} # 警报将变为可见的团队和用户,而不发送任何通知
actions: {value} # 警报可用的自定义操作
tags: {value} # 警报的标签
details: {value} # 用作警报自定义属性的键值对映射
entity: {value} # 警报的实体字段,通常用于指定警报相关的域
priority: {value} # 警报的优先级
type: {value} # 请求的类型,例如 create_alert、close_alert
# 附加参数请查看以下工作流示例:
- failed-to-login-workflow.yml
- opsgenie-close-alert.yml
- opsgenie-create-alert-cel.yml
- opsgenie-create-alert.yml
- opsgenie_open_alerts.yml
提供商方法
close_alert 关闭警报(操作,范围:opsgenie:create)
comment_alert 评论警报(操作,范围:opsgenie:create)
连接 Provider
要使用 Opsgenie Provider,您需要从 API Integration 提供 API 密钥和集成名称。您可以在 Settings -> Integrations -> Add integration 下创建 API 集成,搜索 API Integration。选择 API,为集成提供一个名称,然后点击 continue。
您可以在 Settings -> Integrations -> Add integration 下创建集成密钥
::: note 如果您使用的是免费版,集成密钥可以在 Teams -> 您的团队 -> Integrations -> Add Integration (API) 下创建。 :::
访问 Opsgenie API Integration 以快速创建 API 集成。
访问 Opsgenie API Integration 文档以获取最新信息。
相关链接
- How to create Opsgenie API Integration - https://support.atlassian.com/opsgenie/docs/create-a-default-api-integration/