Backup for VPCのイベント通知を有効にする

「 IBM Cloud® Event Notifications 」を設定し、「Backup for VPC」のジョブが失敗した際にアラートを受信できるようにします。 Eメール、SMS、またはWebhookを介して通知を送信し、バックアップスナップショットの作成状況、保存期間の超過、および一貫性グループの問題を監視します。

Event Notifications に情報を送信するには、IBM Cloud Backup for VPC インスタンスを Event Notifications に接続する必要があります。 Event Notificationsの操作について詳しくは、Event Notifications の使い始め方をご覧ください。

IBM Cloud Backup for VPC によるイベントの収集と送信方法

バックアップジョブは2種類のタスクを実行する。 1つのタスクはスケジュール通りにバックアップスナップショットを取得し、もう1つのタスクは既存のバックアップを管理し、バックアップの保持ルールを適用します。 バックアップ・ジョブが失敗した場合、IBM Cloud Backup for VPC は接続されている Event Notifications インスタンスと通信し、サポートされている宛先 に通知を転送します。

IBM Cloud Backup for VPC のイベント

次の表は、IBM Cloud Backup for VPC イベントの一覧です。

イベント通知を生成するアクション
イベント・タイプ 説明

ボリュームバックアップジョブの作成失敗

  • service-to-service-policy-missing
  • snapshot-quota-reached
    - snapshots-bad-state
  • snapshots-source-volume-busy
  • snapshot-volume-too-large
  • snapshot-volume-unavailable
  • snapshots-encryption-key-invalid
これらのイベントは、認可がない、既存のスナップショットが多すぎる、またはソースボリュームがビジーであるなどの理由でバックアップジョブがバックアップスナップショットを作成できない場合に作成されます。 詳細については、スナップショット制限スナップショットライフサイクル状態、および サービス間認証 を参照してください。 可能な修正方法の詳細については、「 バックアップのトラブルシューティング 」トピックを参照してください。

ボリュームバックアップジョブの保持失敗

  • service-to-service-policy-missing
  • snapshot-bad-state
  • snapshot-in-pending-state
これらのイベントは、バックアップジョブが認証がないためにバックアップスナップショットを削除できない場合や、スナップショットが pending または bad の状態であった場合に作成されます。 詳細については、スナップショットのライフサイクル状態、および サービス間認証 を参照してください。

インスタンスバックアップジョブの作成失敗

  • service-to-service-policy-missing
  • snapshot_consistency_group-quota-reached
    - snapshot_consistency_group-bad-state
  • snapshot_consistency_group-source-volume-busy
  • snapshot_consistency_group-volume-too-large
  • snapshot_consistency_group-volume-unavailable
  • snapshot_consistency_group-encryption-key-invalid
これらのイベントは、バックアップ・ジョブがさまざまな理由で整合性グループのスナップショットを作成できない場合に作成されます。 たとえば、認証がない、ボリュームがアタッチされているインスタンスが利用できない、暗号化キーにアクセスできない、ボリュームのサイズやスナップショット数のサービス制限に達している、などである。 詳細については、スナップショットのライフサイクル状態、および サービス間認証 を参照してください。 可能な修正方法の詳細については、「 バックアップのトラブルシューティング 」トピックを参照してください。

インスタンスバックアップのジョブ保持の失敗

  • service-to-service-policy-missing
  • snapshot_consistency_group-bad-state
  • snapshot-consistency-group-in-pending-state
これらのイベントは、整合性グループの一部であるバックアップスナップショットをバックアップジョブが権限不足のために削除できない場合、またはスナップショットが pending 状態にある場合に作成されます。 詳細については、スナップショットのライフサイクル状態、および サービス間認証 を参照してください。 可能な修正方法の詳細については、「 バックアップのトラブルシューティング 」トピックを参照してください。

これらのアラートが表示されたら、API または CLI を使用して、失敗したステータスの理由を確認できます。

問題の解決方法の詳細については、Troubleshooting Backup for VPC を参照してください。

通知を有効にしています

IBM Cloud Backup for VPC サービスのインスタンスによって生成されたイベントは、同じアカウント内で利用可能な Event Notifications サービスのインスタンスに転送することができます。 1つの Event Notifications サービスインスタンスに対して、設定できるバックアップサービスソースは1つだけです。

IBM Cloud Backup for VPC と Event Notifications の間の IAM 認証がアカウントにまだ存在しない場合は、イベント ソース マネージャー ロールで作成してください。 詳細については、サービス間認証の確立 を参照してください。

IBM Cloud Backup for VPC の通知を有効にする前に、Event Notifications サービス・インスタンスが、IBM Cloud Backup for VPC インスタンスと同じアカウントにあることを確認してください。

その後、「 IBM Cloud Backup 」ポリシー詳細ページの [ アクション] > [イベント通知] セクションを使用して、各サービスを連携させることができます。

その後、イベント通知APIを呼び出すことで、プログラムから Event Notifications に接続することができます。

コンソールから Event Notifications に接続する

  1. IBM Cloud コンソールで、 ナビゲーション メニューアイコン> インフラストラクチャVPC アイコン> ストレージ > バックアップ ポリシー をクリックします。

  2. ポリシー名をクリックします。

  3. アクション アクションアイコン をクリックし、イベント通知を選択します。

  4. Event Notificationsサイドパネルで、接続元の詳細を確認し、説明を入力します。

  5. 接続したいリソースグループと Event Notifications のサービスインスタンスを選択してください。

    IBM Cloud Backup for VPC と Event Notifications の間の IAM 認証がアカウントに存在しない場合は、「 Eabling service-to-service authorization for Event Notifications 」の手順に従って設定してください。 権限を設定するには、AIM管理者ロールが必要です。

  6. 接続を確認するには、「 保存 」をクリックしてください。

CLIからEvent Notificationsに接続する

IBM Cloud Backup for VPC ソースを CLI から接続するには、ibmcloud event-notifications sources-create コマンドを使用します。

ibmcloud event-notifications sources-create --instance-id INSTANCE-ID --name NAME --source BACKUP POLICY CRN --description DESCRIPTION [--enabled ENABLED]

詳細については、イベント通知CLIリファレンスを参照してください。

APIでEvent Notificationsに接続しています

以下の例は、 IBM Cloud Backup for VPC のソース情報を Event Notifications に登録するために使用できるクエリを示しています。 APIを呼び出す際は、ID変数とIAMトークンを、ご使用の IBM Cloud Backup for VPC インスタンス固有の値に置き換えてください。

event_notifications_instance_crn 」の値は、コンソールで「リソース一覧」ページに移動し、「 Event Notifications 」インスタンスの行をクリックすると確認できます。

curl -X POST "{base_url}/v1/instances/{instance_id}/sources"
    -H "Authorization: Bearer {iam_token}"
    -H "Content-Type: application/json"
    -d '{
      "name":"Event Notification Source - Backup policy",
      "source" : "crn:v1:bluemix:public:is:us-south:a/{{account_id}}::backup-policy:",
      "description":"Backup policy service registration. This source provides notifications for backup job failures.",
      "enabled":true,
      "event_notifications_instance_crn": "crn:v1:bluemix:public:event-notifications:<region>:a/<account-id>:<service-instance>::"
      }'

応答が成功すると、接続された Event Notifications サービスインスタンスのCRN値が返されます。 必須およびオプションのリクエストパラメータについての詳細は、Event Notification API docs を参照してください。

Terraform で Event Notifications に接続する

IBM Cloud Backup for VPC サービスを Event Notifications に接続するには、ibm_en_source リソースを使用します。 引数と属性の詳細については、ibm_en_source リソースの Terraform リファレンスを参照してください。

resource "ibm_en_source" "en_source" {
  instance_guid = ibm_resource_instance.en_terraform_test_resource.guid
  name          = "EN Source for Backup jobs"
  source        = "crn:v1:bluemix:public:is:us-south:a/{{account_id}}::backup-policy:"
  description   = "API source for Event notification destinations"
  enabled       = true
}

選択した宛先に通知を配信しています

IBM Cloud Backup for VPC の通知を有効にした後、 Event Notifications でトピックとサブスクリプションを作成し、アラートが選択した宛先に転送・配信されるようにしてください。

サポートされる宛先の完全なリストについては、Event Notificationsドキュメントをご覧ください。

E メール通知

IBM Cloud 電子メール・サービス を、IBM Cloud Backup for VPC イベント通知の配信チャネルとして使用できます。 既存のトピックとIBM Cloudメール・サービスの間に、Event Notificationsサブスクリプションを作成して、アラートをメールでさまざまな受信者に転送します。

IBM Cloudからの、IBM Cloud Backup for VPC イベントに関する情報を含む電子メールは、次の例に似ています:

Email Title: Volume Backup Job Creation Failure

Email Body:

Volume Backup Job Creation Failure. Resource: crn:v1:bluemix:public:is:us-south-1:a/be09dae34250437f96fc8b27ae7d233b::volume:r006-f6583aac-8ba9-4d04-ab7a-acfe7b420016. BackupJobID: r006-899ab8fb-3b71-4fc8-bca5-1544cb425e4f. Reason: Snapshot quota per volume reached.

Notification details:

 {
        "backup_policy": "r006-306fd8f6-b14c-410d-8f29-f05282b6daa9",
        "backup_policy_job": "r006-899ab8fb-3b71-4fc8-bca5-1544cb425e4f",
        "backup_policy_plan": "r006-444bb07f-3399-42d5-b895-febcaca8d1bc",
        "match_resource_type" : "volume",
        "job_type" : "creation",
        "reasons": [
          {
            "more_info": "https://cloud.ibm.com/docs/vpc?topic=vpc-troubleshooting-backup-for-vpc",
            "status": "source_volume_too_large"
          }
        ],
        "resource": "crn:v1:bluemix:public:is:us-south-1:a/be09dae34250437f96fc8b27ae7d233b::volume:r006-f6583aac-8ba9-4d04-ab7a-acfe7b420016"
 }

E メール内のイベント通知に関する詳細情報を受信するには、Event Notifications サブスクリプションの作成時に**「通知ペイロードの追加」** オプションを選択します。 イベントに関連付けられた「通知ペイロードの詳細」が E メールに表示されます。

Webhook

着信通知をアプリまたはサービスによってプログラマチックにコンシュームするため、Webhookの配信先を構成できます。 Webhookのセットアップについて詳しくは、Event Notificationsドキュメントを確認してください。

通知ペイロードの詳細

IBM Cloud Backup for VPC によって生成される成功イベントには、イベントの発生元や詳細を特定するのに役立つさまざまなフィールドが含まれています。

IBM Cloud Backup for VPC からのイベント通知には、リソースの名前や識別子などのメタデータプロパティのみが含まれています。 APIキーやパスワードなどの機密データは、生成されるイベントには含まれません。

Event Notifications に送信されるプロパティは、イベントの種類によって異なります。 たとえば、Backup job creation failed イベントが発生すると、IBM Cloud Backup for VPC は、次の例と同様の通知ペイロードを Event Notifications に送信します。

{
  "ibmendefaultlong": "{\"status\":\"Backup job creation / retention failed\",
                        \"backup_policy\": r006-6da51cfe-6f7b-4638-a6ba-00e9c327b178,
                        \"backup_policy_plan\":\"r006-076191ba-49c2-4763-94fd-c70de73ee2e6\",
                        \"status_reason\": \"source_volume_busy: The source volume has busy set (after multiple retries)\",
                        \"match_resource_type\": \"instance\",
                        \"job_type\": \"creation\",
                        \"more_info\": \"https://cloud.ibm.com/docs/vpc?topic=vpc-baas-troubleshoot\"}",
  "ibmendefaultshort": "Backup Job creation / retention failed",
  "id": "b2198eb8-04b1-48ec-a78c-ee87694dd845",
  "time": "2024-04-22T20:59:34Z",
  "ibmenseverity": "medium",
  "type": "com.ibm.cloud.is.backup-policy.backup-volume-creation",
  "source": "com.ibm.cloud.is.backup-policy",
  "specversion": "1.0",
  "ibmensourceid": "41cdb7d4-db3e-496b-b7df-d4ead362c412:api"
}