IBM Cloud Docs
通知配信リストの使用

通知配信リストの使用

IBM Cloud 通知の配信リストページでは、アカウント全体のイベントに関する通知の適切な送信先として、メールアドレスまたはウェブフックのセットを指定する方法を提供しています。

IBM Cloud コンソールを使用して通知配布リストを管理することができます。 通知を受け取ることができるメールアドレスを最大10件まで登録できます。 配布リストに追加された E メールには、アカウントに影響を与えるイベントがすべて通知されます。 配布リストに E メール・アドレスを追加するには、アカウント管理サービスに対してエディター以上の役割を持っている必要があります。 詳しくは、アカウント管理サービスへのアクセス権限の割り当てを参照してください。

アカウント所有者が配信リストに追加したメールアドレスには、アカウント所有者の 「通知」ページに表示されるインシデント、メンテナンス、アナウンス、セキュリティ情報に関する通知が送信されます。

E メール・アドレスを追加することに加えて、最大 10 個の Webhook を配布リストに追加することもできます。 アカウント管理者は、Webhook を作成して使用することで、プラットフォーム・イベントが発生するたびに非同期通知を受信するようにアプリケーションを構成することができます。 登録済みの Webhook によって、JSON ペイロードを含む HTTP POST 要求の形式で、情報が指定の URL に送信されます。 要求のコンテンツ・タイプは application/json です。

コンソールで通知配信リストにメールアドレスを追加する

通知の配信リストに電子メールを追加するには、以下の手順に従ってください

  1. IBM Cloud コンソールで、「管理」>「アカウント」 > **「通知配布リスト」**と移動します。

  2. 「追加」>**「E メール」**を選択します。

  3. 名前と E メール・アドレスを入力します。

    最大 10 個の E メール・アドレスを配布リストに追加できます。 E メール・アドレスは、IBM Cloud 内の既知のユーザーに対応する必要はありません。任意のタイプを追加できます。

  4. 追加 をクリックします。

配布リストからのアンサブスクライブ

配布リストからアンサブスクライブするには、配布リストから送信された任意の E メールのフッターにあるリンクを使用してください。

通知配布リストの Event Notifications の有効化

IBM Cloud® Event Notificationsを使用すると、E メール、SMS、Webhook などのさまざまな宛先に通知を配信することを選択できます。 Event Notifications は、通知配布リストの代替手段です。 これにより、アカウントで発生した重大なイベントに関する通知を受け取ることができ、大量の通知を管理することができます。 詳しくは、 Event Notifications を参照してください。

関心のあるイベントが IBM Cloud プラットフォームで発生し、イベントが生成されると、通知配布リストは接続された Event Notifications インスタンスと通信して、サポートされる宛先に通知を転送します。 サポートされる 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 インスタンスを削除するには、以下の手順を実行します。

  1. 通知配布リストから削除する Event Notifications サービス・インスタンスを選択し、 「アクション」 アイコン 「アクション」 をクリックします。
  2. **「削除」**をクリックします。

配布リストへの Web フックの追加

Web フックを配布リストに追加するには、以下の手順を実行します。

  1. IBM Cloud® コンソールで管理 > アカウント > 通知配布リストに移動します。

  2. **「追加」をクリックし、「Webhook の追加」**を選択します。

  3. ウェブフックの識別名とエンドポイントを入力します。 URL ウェブフックがトリガーされた際にイベント通知が送信されます。 お客様自身のカスタム・エンドポイントとなる URL をセットアップしてください。

    カスタム・ヘッダーとセキュア・ヘッダーのフィールドを設定することもできます。 これらを指定するには、**「ヘッダーの追加」または「セキュア・ヘッダーの追加」**をクリックします。 資格情報のためにセキュア・ヘッダーを追加した場合は、プライベート・データとともに資格情報が暗号化されて渡されます。 このタイプのヘッダーは、後で削除はできますが、編集はできません。 カスタム・ヘッダーは、後で簡単に編集および削除できます。

    通知を受信する必要がなくなった場合は、Webhook の行にある アクション・アイコンアクション・アイコン > 削除をクリックして、配布リストから Webhook を簡単に削除できます。

    コンソールでアカウント・スイッチャーをクリックして、使用する 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
}

ヘッダー

ウェブフックを追加した際にUIで設定したヘッダー付きのペイロードと、セマンティックバージョン番号を持つ追加のバージョンヘッダーを受け取ります。 このバージョン・ヘッダーを使用して、予期される Webhook ペイロードの形式を判別できます。

現行のバージョン・ヘッダーは "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: title フィールドには、何についての通知であるかが表示されます。 このフィールドは多くの言語に対応できるように構成されていますが、現在サポートされているのは英語のみです。

startTimeendTime: イベントの開始時刻と終了時刻を確認できます。

startTimeendTime のフィールドには、イベントの開始時刻と終了時刻が Unix 協定世界時タイム・スタンプ形式で表示されます。

ペイロードに入れて送信されるフィールドには、必須のものとオプションのものとがあります。 オプションのフィールド (startTime など) は、そのタイプの情報が通知に含まれる場合に渡され、含まれない場合は渡されません。 必須のフィールド (category など) は、すべての場合に渡されます。 以下の表に、必須のフィールドとオプションのフィールドを区別してリストします。

ペイロードのフィールド
フィールド 必須またはオプション
account_id: account_id 必須
category: notification.category 必須
title: notification.title 必須
startTime: notification.startTime オプション
endTime: notification.endTime オプション
updateTime: notification.updateTime オプション
body: notification.body 必須
state: notification.state オプション
sourceID: notification.sourceID オプション
regions: notification.regions オプション
continentNames: notification.絶え間ない名前 オプション
regionNames: notification.regionNames オプション
componentNames: notification.componentNames オプション
subCategory: notification.subCategory オプション
severity: notification.severity オプション

大きなバージョン変更をしなくても、将来的にフィールドが追加されるかもしれない。 つまり、通知を処理するコードは、認識できないフィールドを無視するように作成する必要があります。

ウェブフックにテスト通知を送信する

前のステップでの準備ができており、構成済みの Webhook があれば、そのテストは簡単です。 テスト通知を Webhook に送信することにより、Webhook 統合が正しく機能していて通知を受信することを確認します。

テスト通知を Webhook に送信するには、以下のステップを実行します。

  1. IBM Cloud コンソールで管理 > アカウント > 通知配布リストに移動します。
  2. テスト通知の送信先となる Webhook を選択し、アクション・アイコンアクションをクリックします。
  3. 「テスト」 > **「テストの送信 (Send test)」**をクリックします。
  4. テスト通知を再送するには、**「テストの再送 (Resend test)」**をクリックします。

配布リストへの Slack Web フックの追加

Slackのウェブフックを配信リストに追加し、それらを通じてアカウント全体にわたる IBM Cloud 通知を受け取ることができます。

Webhook を作成するには、まず Slack でアプリをセットアップし、着信 Webhook を作成します。これによって、通知メッセージ・テキストを JSON ペイロードの形式で送信できる固有の URL が与えられます。 アプリがインストールされた、選択した Slack チャネルで通知を受け取れるようになります。 詳細については 、「Incoming Webhooks を使用したメッセージの送信 」を参照してください。

IBM Cloud コンソールに Slack の Webhook を追加するには、以下の手順を実行します。

  1. IBM Cloud コンソールで管理 > アカウント > 通知配布リストに移動します。
  2. **「追加」をクリックし、「Slack」**を選択します。
  3. Webhook の名前と Slack Webhook URL を入力します。 通知はこの固有の URL に送信されます。

配布リストへの Microsoft Teams Web フックの追加

アカウント全体の IBM Cloud 通知を受信するために、Microsoft Teams の Webhook を配布リストに追加することもできます。

IBM Cloud コンソールで Webhook を作成するには、まず Microsoft Teams で着信 Webhook を作成します。 これにより、外部アプリは Teams チャネルでコンテンツを共有することが可能になり、JSON ペイロードの形式の通知メッセージ・テキストを送信できる固有の URL を提供します。 通知は、着信 Webhook を追加した、選択した Teams チャネルで受け取ります。 詳細については、着信Webhookの作成を参照してください。

IBM Cloud コンソールに Microsoft Teams の Webhook を追加するには、以下の手順を実行します。

  1. IBM Cloud コンソールで管理 > アカウント > 通知配布リストに移動します。
  2. **「追加」をクリックし、「Microsoft Teams」**を選択します。
  3. Webhook の名前と Microsoft Teams の Webhook URL を入力します。 通知はこの固有の URL に送信されます。

ServiceNow ウェブフックの設定

Microsoft Teams Webhook および Slack Webhook の統合とは異なり、ServiceNow Webhook をセットアップするには、Webhook 宛先側での構成が必要です。

まず、ServiceNow Web サイトで Scripted REST API を作成する必要があります。 Scripted REST API を構成したら、Scripted REST API リソースも作成する必要があります。 要求メソッドは HTTP POST に設定する必要があります。 その後に、リソースで実行するコードを指定します。

プロセスの準備ができ、Scripted REST API の URL を用意したら、**「IBM Cloud 通知配布リスト (IBM Cloud Notification distribution list)」**ページでその使用を開始し、Webhook を作成できます。

ServiceNow のウェブフック統合プロセスを完全に理解するには 、「 ServiceNow にウェブフックを統合する方法」というブログ記事の手順に従ってください。 このブログではステップを詳しく説明しています。