取消订阅分发列表

要取消订阅分发列表，请使用分发列表发送的任何电子邮件页脚中的链接。

通知事件

下表列出了通知服务发送到 Event Notifications 的事件类型：

在通知分发列表中添加 Event Notifications 实例

在将任何 Event Notifications 实例添加到通知分发列表之前，请确保已经有一个与分发列表位于同一账户中的 Event Notifications 服务实例。 如果没有 Event Notifications 服务实例，请参阅 Event Notifications 入门。 要将现有 Event Notifications 服务实例添加到通知分发列表，请完成以下步骤：

1. 使用 IBM Cloud 控制台，转到管理 > 帐户 > 通知分发列表。
2. 单击添加 >。Event Notifications.
3. 从 Event Notifications 实例列表中选择 Event Notifications 服务实例。 如果没有可以连接到账户的 Event Notifications 服务实例，可以在 IBM Cloud 目录中创建一个。
4. 单击添加。

不能将 Event Notifications 服务实例添加到已配置的通知分发列表中。

向 Event Notifications 实例发送测试通知

将 Event Notifications 实例添加到通知分发列表后，可以对其进行测试，以确保通知服务生成的事件被转发到该实例。

完成以下步骤，向 Event Notifications 实例发送测试通知：

1. 在 IBM Cloud 控制台中，转到管理 > 帐户 > 通知分发列表。
2. 选择要发送测试通知的 Event Notifications 实例，然后单击操作图标 > 测试。
3. 选择要测试的通知事件类型，然后单击发送测试。
   1. 要重新发送测试通知，请单击重新发送测试。

通知有效载荷详情

当 Event Notifications 实例被添加到账户的分发列表中，且账户收到通知时，通知有效载荷将被发送到该 Event Notifications 实例。 所有事件类型的有效载荷对象属性都相同。 请参阅以下有效载荷示例，其中包含发送测试通知的维护事件的详细信息：

{
   "instanceId": "12345678-abcd-1234-efgh-1234567890ab",
   "id": "CHG1234567",
   "source": "crn:v1:bluemix:public:notificationapi::a/<scope>:12345678-abcd-1234-efgh-1234567890ab::",
   "ibmenseverity": "high_impact",
   "severity": "high_impact",
   "ibmensourceid": "crn:v1:bluemix:public:notificationapi::a/<scope>:12345678-abcd-1234-efgh-1234567890ab::",
   "type": "com.ibm.cloud.notificationapi.maintenance",
   "time": "2025-10-08T18:31:09.363Z",
   "ibmendefaultshort": "Maintenance - High Impact: this is a maintenance test notif",
   "ibmendefaultlong": "this is a maintenance test notif \n \nSource ID: CHG1234567 \nType: Maintenance \nSeverity: High Impact \nStart Time: 23 Oct 2025, 7:09 PM UTC \nEnd Time: 24 Oct 2025, 7:09 PM UTC \nUpdate Time: 21 Oct 2025, 2:52 AM UTC \n\nthis is the body text and sev = 1\n\nThis is a test email, please disregard\n\n\n",
   "ibmensmstext": "Maintenance - High Impact: this is a maintenance test notif \nSource ID: CHG2755299 \nCategory: Maintenance \nSeverity: High Impact \n",
   "ibmensubject": "Maintenance - High Impact: this is a maintenance test notif",
   "ibmenhtmlbody": "<div> this is a maintenance test notif</div></br><div><div><b>Source ID:</b> CHG2755299</div><div><b>Type:</b> Maintenance</div><div><b>Severity:</b> High Impact</div><div><b>Start Time:</b> 23 Oct 2025, 7:09 PM UTC</div><div><b>End Time:</b> 24 Oct 2025, 7:09 PM UTC</div><div><b>Update Time:</b> 21 Oct 2025, 2:52 AM UTC</div></br>this is the body text and sev = 1</br></div><div></br><b>This is a test email, please disregard</b></br><div>",
   "specversion": "1.0",
   "datacontenttype": "application/json",
   "data": {
       "sourceID": "CHG1234567",
       "category": "maintenance",
       "severity": 1,
       "crnMasks": [],
       "startTime": "1761246551",
       "endTime": "1761332951",
       "title": [
           {
               "language": "en",
               "text": "this is a maintenance test notif"
           }
       ],
       "body": [
           {
               "content-type": "text/html",
               "language": "en",
               "text": "this is the body text and sev = 1"
           }
       ]
   }
}

查看下表，了解有关 Event Notifications 通知有效负载属性的更多信息。

删除 Event Notifications 实例

您可以通过完成以下步骤删除已添加到通知分发列表的任何 Event Notifications 实例：

1. 选择要从通知分发列表中删除的 Event Notifications 服务实例，然后单击操作图标。
2. 单击删除。

头

您收到的有效载荷带有您在添加网络钩子时在用户界面中配置的标头，以及带有语义版本号的附加版本标头。 该版本标头可用于确定网络钩子有效负载的预期格式。

当前版本标头为 "IBM-Notifications-API-Version": "v2.0.0"。

字段值

以下说明提供了有关有效载荷内发送的字段值的信息：

body:该字段描述平台上发生的与您有关的事件。 该字段包含对通知的详细、可读的描述，可长达数个段落。 它还可以包含 html 格式。 该字段的配置可支持更多语言，但目前仅支持英语。

category:事件类型。 这可以是事件、维护、公告或安全公告。

componentNames:如果服务受到影响，则该字段表示该服务。 这也可以是一个全局值，如 Component: IBM Cloud，而不仅仅是一个特定的服务。 请参见 IBM Cloud 目录页面上的服务。

regions:该字段显示事件发生的位置。

severity:该字段指事件的严重程度。 事件的严重程度可以是 1、2、3 或 4，维护的严重程度可以是高、中或低，公告的严重程度可以是大或小。 请参阅以下详细的严重性级别说明：

* **Incidents**
  * `Severity 1`: Business-critical functionality is inoperable or critical interference failed. This severity usually applies to the production environment and the inability to access services is causing a critical impact on operations.
  * `Severity 2`: Core functionality is impacted. Service is operational but causing major impact on usage.
  * `Severity 3`: Partial or noncritical disruption to functionality with minimal or isolated impact.
  * `Severity 4`: A minor issue that requires action, but does not impact functionality or usage.
* **Maintenance**
  * `High impact`: Maintenance will, or is likely to cause service outages and disruptions.
  * `Medium impact`: Maintenance will, or is likely to cause measurable service degradation but not an actual outage.
  * `Low impact`: Maintenance will cause no service disruption during or after the maintenance window.
* **Announcements**
  * `Major`: Important incidents such as legal notices, service deprecation, or security patches.
  * `Minor`: Informative announcements such as product enhancements.

请求有效负载中的严重性属性值可以是 0、1、2、3 或 4。 下表列出了严重性值及其相应的分类：

state:该字段仅用于维护和通知。 请参见以下可能的值：

* Values for *Maintenance* states: Planned, In progress, Completed, Canceled, Failed
* Values for *Incident* states: New issue, Investigating, Resolved

title:标题字段告诉您通知的内容。 该字段的配置可支持更多语言，但目前仅支持英语。

startTime, endTime: 您可以查看事件开始和结束的时间。

startTime 和 endTime 字段以 Unix 协调世界时时间戳显示事件的开始时间和结束时间。

有效载荷中发送的字段可以是必填字段，也可以是可选字段。 如果通知中有此类信息，则会传递可选字段，例如 startTime；如果通知中没有此类信息，则不会传递可选字段。 必填字段，如 category，在任何情况下都会通过。 下表列出了哪些字段是必填字段，哪些是可选字段：

| 字段 | 必填或可选 | 选项 |--|--| |account_id: account_id|Required| | 类别：notification.category |要求 | 标题：notification.title |Required| | 开始时间：notification.startTime |可选 |结束 时间：notification.endTime |可选 |更新 时间：notification.updateTime |可选 |body：notification.body |要求 | 状态：notification.state |可选 |sourceID：notification.sourceID |可选 | 区域：notification.regions | 可选 |continentNames：notification.continentNames|Optional| |区域名称：notification.regionNames|Optional| | 组件名称：notification.componentNames | 可选 |subCategory：notification.subCategory|Optional| | 严重性：notification.severity |可选

今后可能会在不对版本进行重大修改的情况下添加其他字段。 这意味着任何处理通知的代码都应准备好忽略其无法识别的字段。

向网络钩子发送测试通知

如果前面的步骤已经准备就绪，并配置了网络钩子，就可以轻松进行测试了。 向网络钩子发送测试通知，确保网络钩子集成工作正常并能接收到通知。

完成以下步骤，向网络钩子发送测试通知：

1. 转到 IBM Cloud 控制台中的管理 > 帐户 > 通知分发列表。
2. 选择要发送测试通知的网络钩子，然后单击操作图标。
3. 单击测试 > 发送测试。
4. 要重新发送测试通知，请单击重新发送测试。