airflow.providers.opsgenie.hooks.opsgenie

OpsgenieAlertHook

此 Hook 允许您发布警报到 Opsgenie。

模块内容

class airflow.providers.opsgenie.hooks.opsgenie.OpsgenieAlertHook(opsgenie_conn_id='opsgenie_default')[源码]

基类: airflow.hooks.base.BaseHook

此 Hook 允许您发布警报到 Opsgenie。

接受一个连接,该连接的密码字段包含一个 Opsgenie API 密钥。此 hook 将域设置为 conn_id.host,如果未设置,则默认为 https://api.opsgenie.com

每个 Opsgenie API 密钥都可以预先配置到团队集成中。您可以在此 hook 中覆盖这些默认设置。

参数:

opsgenie_conn_id (str) – 要使用的 Opsgenie 连接的名称

conn_name_attr = 'opsgenie_conn_id'[源码]
default_conn_name = 'opsgenie_default'[源码]
conn_type = 'opsgenie'[源码]
hook_name = 'Opsgenie'[源码]
conn_id = 'opsgenie_default'[源码]
alert_api_instance[源码]
get_conn()[源码]

获取底层的 AlertApi 客户端。

返回:

AlertApi 客户端

返回类型:

opsgenie_sdk.AlertApi

create_alert(payload=None)[源码]

在 Opsgenie 上创建一个警报。

参数:

payload (dict | None) – Opsgenie API Create Alert 有效载荷值 参见 https://docs.opsgenie.com/docs/alert-api#section-create-alert

返回:

api 响应

返回类型:

opsgenie_sdk.SuccessResponse

close_alert(identifier, identifier_type='id', payload=None, **kwargs)[源码]

在 Opsgenie 中关闭一个警报。

参数:
返回:

SuccessResponse 如果方法异步调用,则返回请求线程。

返回类型:

opsgenie_sdk.SuccessResponse

delete_alert(identifier, identifier_type=None, user=None, source=None)[源码]

在 Opsgenie 中删除一个警报。

参数:
  • identifier (str) – 警报的标识符,可以是警报 ID、tiny ID 或警报别名。

  • identifier_type (str | None) – 作为内联参数提供的标识符类型。可能的值有 'id'、'alias' 或 'tiny'

  • user (str | None) – 请求所有者的显示名称。

  • source (str | None) – 请求源的显示名称

返回:

SuccessResponse

返回类型:

opsgenie_sdk.SuccessResponse

classmethod get_ui_field_behaviour()[源码]

返回 Opsgenie 连接的自定义 UI 字段行为。

此条目是否有帮助?