使用通知分发列表
IBM Cloud 通知分发列表页面 提供了一种方法,供您指定一组电子邮件地址或 Webhook,以便为有关帐户范围事件的通知设置合适的目标。
您可以使用 IBM Cloud 控制台来管理通知分发列表。 您最多可以创建 10 个接收通知的电子邮件地址列表。 将向分发列表添加的电子邮件通知影响帐户的任何事件。 您必须在帐户管理服务上具有编辑者角色或更高角色,才能将电子邮件地址添加到分发列表。 有关更多信息,请参阅 分配对帐户管理服务的访问权。
帐户所有者添加到分发列表的电子邮件地址将接收有关帐户所有者的 "通知" 页面上显示的任何事件,维护,声明或安全公告的通知。
除了添加电子邮件地址外,您还可以在分发列表中添加多达 10 个网络钩子。 账户管理员可以创建并使用网络钩子来配置应用程序,以便在平台事件发生时接收异步通知。 注册的网络挂钩以 HTTP POST请求的形式将信息发送到指定的 URL,并带有JSON有效负载。 请求的内容类型为 "application/json
。
在控制台中向通知分发列表添加电子邮件地址
要向通知分发列表添加电子邮件,请完成以下步骤:
-
使用 IBM Cloud 控制台,转至 管理 > 帐户 > 通知分发列表。
-
选择 添加 > 电子邮件。
-
输入名称和电子邮件地址。
您可以在通讯组列表中添加 10 个电子邮件地址。 电子邮件地址不需要对应于 IBM Cloud中的已知用户,您可以添加任何类型。
-
单击添加。
从分发列表中取消预订
要从分发列表中取消预订,请使用从分发列表中发送的任何电子邮件的页脚中的链接。
对通知分发列表启用 Event Notifications
通过 IBM Cloud® Event Notifications,您可以选择将通知传递到不同的目标,包括电子邮件,SMS 或 Webhook。Event Notifications 是通知分发列表的替代方法。 它为您提供了一种方法,用于接收有关帐户中发生的关键事件的通知,并大规模管理通知。 有关更多信息,请参阅 Event Notifications。
在 IBM Cloud 平台上发生相关事件并生成事件时,通知分发列表会与已连接的 Event Notifications 实例进行通信,以将通知转发到受支持的目标。 有关受支持的 Event Notifications 目标的更多信息,请参阅 事件目标。
将 Event Notifications 实例添加到通知分发列表
在将任何Event Notifications实例添加到通知分发列表之前,请确保您已经拥有与分发列表位于同一账户中的 Event Notifications服务实例。 如果您没有 Event Notifications 服务实例,请参阅 Event Notifications 入门指南。 要将现有Event Notifications服务实例添加到通知分发列表,请完成以下步骤:
- 使用 IBM Cloud 控制台,转至 管理 > 帐户 > 通知分发列表。
- 单击 添加 > Event Notifications。
- 从 Event Notifications 实例列表中选择 Event Notifications 服务实例。 如果您没有可以连接到帐户的 Event Notifications 服务实例,那么可以在 IBM Cloud 目录中创建一个服务实例。
- 单击添加。
无法将 Event Notifications 服务实例添加到已配置的通知分发列表。
删除一个 Event Notifications 实例
您可以通过完成以下步骤来删除添加到通知分发列表的任何 Event Notifications 实例:
- 选择要从通知分发列表中删除的 Event Notifications 服务实例,然后单击 操作 图标
。
- 单击删除。
在分发列表中添加网络钩子
要在分发列表中添加网络钩子,请完成以下步骤:
-
转到IBM Cloud®控制台中的“管理”>“账户”>“通知分发列表”。
-
单击添加,然后选择添加网络钩子。
-
输入您的网络挂钩的名称标识符和端点 URL,当网络挂钩被触发时,事件通知将发送至此。 设置 URL 作为您自己的自定义终端。
还可设置自定义标题和安全标题字段。 您可以单击添加标题或添加安全标题来指定这些内容。 如果选择为凭据添加安全标头,它们将与私人数据一起加密传输。 这类页眉可以删除,但以后无法编辑。 您以后可以轻松编辑和删除自定义标题。
如果不想再接收通知,可以点击网络钩子行中的操作图标
>删除,从分发列表中轻松删除网络钩子。
点击控制台中的账户切换器,即可选择使用哪个IBM Cloud账户。 所选账户的用户会收到有关影响该账户的任何事件的通知。
当您通过webhook收到通知时,有效负载将发送到您指定的webhook终端( URL ),并通知您正在发生的事件的所有细节。 请参阅以下示例:
{
"account_id": "2dd2d2de4add4a098ebd0999be5cc555",
"body": [
{
"language": "en",
"text": "<p><br />SERVICES/COMPONENTS AFFECTED:<br />- Cloudant NoSQL DB<br />- Code Engine<br />- DNS Services<br />- App ID<br />- IBM Watson Machine Learning<br />- Continuous Delivery - Toolchain<br />- MQ in IBM Cloud<br />- Hyper Protect Crypto Services<br /><br />IMPACT:<br />- Users may experience connectivity issues when trying to connect to Cloudant services.<br /><br />STATUS:<br />- 2021-05-25 14:54 UTC - INVESTIGATING - We are aware of the issue and are currently investigating. More information will be provided as it becomes available.</p>"
}
],
"category": "Incident",
"componentNames": "Cloudant",
"continentNames": [
"North America",
"Europe",
"Asia Pacific"
],
"regionNames": [
"Washington DC",
"London",
"Dallas",
"Sydney",
"Tokyo",
"Frankfurt"
],
"regions": [
"us-east",
"eu-gb",
"us-south",
"au-syd",
"jp-tok",
"eu-de"
],
"severity": "Severity 1",
"sourceID": "INC3918600",
"startTime": 1621949594,
"state": "Investigating",
"title": [
{
"language": "en",
"text": "INVESTIGATING: IBM Cloudant - selective services are unavailable"
}
],
"updateTime": 1621954682
}
头
您收到的有效载荷带有您在添加网络钩子时在用户界面中配置的标头,以及带有语义版本号的附加版本标头。 该版本标头可用于确定网络钩子有效负载的预期格式。
当前版本标题为 ""IBM-Notifications-API-Version": "v2.0.0"
。
字段值
以下说明提供了有关有效载荷内发送的字段值的信息:
body
:该字段描述平台上发生的与您有关的事件。 该字段包含对通知的详细、可读的描述,可长达数个段落。 它还可以包含 html 格式。 该字段的配置可支持更多语言,但目前仅支持英语。
category
:活动类型。 这可以是事件、维护、公告或安全公告。
componentNames
:如果服务受到影响,则该字段代表该服务。 这也可以是一个全局值,如 "Component: IBM Cloud
,而不仅仅是一个特定的服务。 请参见 IBM Cloud目录页面上的服务。
regions
:该字段显示事件发生的地点。
severity
:该字段指事件的严重程度。 事件的严重程度可以是 1、2、3 或 4,维护的严重程度可以是高、中或低,公告的严重程度可以是大或小。 请参阅以下详细的严重性级别说明:
- 事件
Severity 1
:关键业务功能无法运行或关键干扰失败。 此严重性通常适用于生产环境,表明无法访问服务会对运营产生严重影响。Severity 2
:核心功能受到影响。 服务在运行,但对其使用造成了重大影响。Severity 3
:功能部分或非关键性中断,影响轻微或孤立。Severity 4
:需要采取行动的小问题,但不会影响功能或使用。
- 维护
High impact
:维护工作将或可能会导致服务中断和故障。Medium impact
:维护将或可能会导致可测量的服务降级,但不会导致实际中断。Low impact
:在保养期间或保养后,保养不会导致服务中断。
- 声明
Major
:重要事件,如法律通知、服务弃用或安全补丁。Minor
:信息公告,例如产品改进。
state
:该字段仅用于维护和通知。 请参见以下可能的值:
- 维护状态的值:计划、进行中、完成、取消、失败
- 事件状态的值:新问题、调查中、已解决
title
:标题字段告诉您通知的内容。 该字段的配置可支持更多语言,但目前仅支持英语。
startTime
endTime
:您可以查看事件开始和结束的时间。
startTime
和 "endTime
字段用 Unix 协调世界时时间戳显示事件的开始时间和结束时间。
有效载荷中发送的字段可以是必填字段,也可以是可选字段。 如果通知中有此类信息,则会传递可选字段,例如 "startTime
;如果通知中没有此类信息,则不会传递可选字段。 必填字段,例如 "category
,在任何情况下都会被传递。 下表列出了哪些字段是必填字段,哪些是可选字段:
字段 必填或选填 |--|--| |account_id: account_id|Required| |category:notification.category |title:notification.titletitle |Required| |startTime:notification.startTime选项| |endTime:notification.endTime选项| |updateTime:notification.updateTime选项| |body:notification.body |state:notification.state |sourceID:notification.sourceID选项| | 区域:notification.regions | 大陆名称: notification.continentNames|Optional| | 区域名称: notification.regionNames|Optional| | 组件名: 'notification.componentNames可选 | 子类别: notification.subCategory|Optional| | 严重性:notification.severity
今后可能会在不对版本进行重大修改的情况下添加其他字段。 这意味着任何处理通知的代码都应准备好忽略其无法识别的字段。
向网络钩子发送测试通知
如果前面的步骤已经准备就绪,并配置了网络钩子,就可以轻松进行测试了。 向网络钩子发送测试通知,确保网络钩子集成工作正常并能接收到通知。
完成以下步骤,向网络钩子发送测试通知:
- 转到IBM Cloud控制台中的管理>帐户>通知分发列表。
- 选择要发送测试通知的网络钩子,然后单击操作图标
。
- 单击测试>发送测试。
- 要重新发送测试通知,请单击重新发送测试。
在分发列表中添加 Slack 网络钩子
您可以在分发列表中添加 Slack webhooks,并通过它们接收整个账户的IBM Cloud通知。
要创建网络挂钩,首先在 Slack 中设置一个应用并创建传入网络挂钩,该挂钩提供唯一的 URL,您可以在其中以 JSON 有效负载的形式发送通知消息文本。 您将在安装应用程序的选定 Slack 频道中收到通知。 有关详细信息,请参阅 使用传入 Webhooks 发送信息。
要在IBM Cloud控制台中添加 Slack webhook,请完成以下步骤:
- 转到IBM Cloud控制台中的管理>帐户>通知分发列表。
- 点击 “添加”,选择 “松弛”。
- 输入您的网络挂钩和Slack网络挂钩的名称 URL。 通知将发送至唯一的 URL。
在分发列表中添加 Microsoft Teams 网络钩子
在分发列表中添加 Microsoft Teams 网络钩子还可用于接收整个账户的IBM Cloud通知。
要在IBM Cloud控制台中创建网络钩子,首先要在 Microsoft Teams 中创建传入网络钩子。 这允许外部应用在团队频道中共享内容,并提供唯一的 URL,您可以在其中以JSON有效负载的形式发送通知消息文本。 您会在所选的 Teams 频道中收到通知,您在该频道中添加了传入网络钩子。 更多信息,请参阅 创建传入 Webhook。
要在IBM Cloud控制台中添加 Microsoft Teams 网络钩子,请完成以下步骤:
- 转到IBM Cloud控制台中的管理>帐户>通知分发列表。
- 单击添加,然后选择 Microsoft Teams。
- 为您的网络挂钩和微软团队网络挂钩 URL 输入一个名称。 通知将发送至唯一的 URL。
设置ServiceNow网络钩子
与 Microsoft Teams 和 Slack 网络钩子集成不同,设置ServiceNow网络钩子需要在网络钩子目标端进行配置。
首先,您需要在ServiceNow网站上创建脚本化 REST API。 配置脚本化 REST API 后,还需要创建脚本化 REST API 资源。 请求方法需要设置为 HTTP POST。 然后,您需要提供资源运行的代码。
当您准备好流程并拥有 URL 的脚本化REST API后,您就可以开始在 IBM Cloud 通知分发列表页面上使用它并创建webhooks。
要了解完整的ServiceNowWebhook 集成流程,请按照“如何将 Webhooks 集成到ServiceNow”博文中的说明进行操作。 本博客将为您详细介绍这些步骤。