特定の条件で通知を受信するウォッチャーを登録できます。
ウォッチャーを登録するには、次の API を呼び出します。
POST /api/v1/notification-watcher
ウォッチャーを追加したら、watcher_id を使用して notification_id (feature_name.notification_name) を登録し、ウォッチャーが受信する通知を指定する必要があります。登録しないと、ウォッチャーは通知を受信しません。必須の要求パラメータを指定して次の API を呼び出し、notification_id を登録して通知を指定します。NSX 通知 API の詳細については、『NSX API ガイド』を参照してください。
PUT /api/v1/notification-watchers/<watcher-id>POST /api/v1/notification-watchers/<watcher-id>/notifications?action=add_uri_filters。次の要求パラメータを指定します。- notification_id：feature_name.notification_name を識別する文字列。feature_name.notification_name で指定された URI でウォッチャーが受信する通知を示します。
- uri_filters：ポリシー パスに基づいて通知をフィルタリングする URI のオプション リスト。uri_filters を指定する場合、特定の値ではなく、ワイルドカード文字として * を使用することもできます。
たとえば、notification_id が group.change_name の場合、uri_filter のパターンは /policy/api/v1/infra/domains/<domain>/groups/<group> になります。パターンを /policy/api/v1/infra/domains/domain1/groups/group2 として指定すると、domain1 と group2 に固有の通知を取得できます。また、パターン /policy/api/v1/infra/domains/domain2/groups/* を指定すると、domain2 内のすべてのグループの通知を取得できます。/policy/api/v1/infra/domains/*/groups/* を指定すると、すべてのドメイン内のすべてのグループの通知を取得できます。
| 機能名 | 機能の説明 | 通知名 | 通知の説明 | URI |
|---|---|---|---|---|
| group | NS グループ機能でサポートされている通知。 | change_notification | グループ通知。<domain> はドメイン名を表し、<group> はグループ名を表します。 | /policy/api/v1/infra/domains/<domain>/groups/<group> |
| monitoring | モニタリング機能でサポートされている通知。 | alarm | アラーム通知。<alarm-id> は、アラーム インスタンスを表します。通知は、アラーム インスタンスが作成または削除されたときに送信されます。また、アラーム インスタンスが更新されたときにも送信されます。 | /api/v1/alarms/<alarm-id> |
| alarm_status_change_notification | アラーム通知。<alarm-id> は、アラーム インスタンスを表します。通知は、アラーム インスタンスが作成されたときに送信されます。また、アラーム インスタンスの状態プロパティの値が更新されたときにも送信されます。 | /api/v1/alarms/<alarm-id> | ||
| notification | 通知フレームワークでサポートされる通知。 |
watcher | 更新をウォッチャー構成に送信するプラットフォーム通知。<watcher-id> はウォッチャーを表します。 | /api/v1/notification-watchers/<watcher-id> |
| watcher_notification | 更新を通知に送信するプラットフォーム通知。<watcher-id> はウォッチャーを表します。 | /api/v1/notification-watchers/<watcher-id>/notifications | ||
| service_config | サービス構成機能でサポートされている通知。 | change_notification | サービス構成通知。<domain> はドメイン名、<policy> はエンドポイント ポリシー、<rule> はエンドポイント ルールを表します。この通知は、エンドポイント ルールで使用されているサービス構成が更新されたとき、または UPM プロファイルが更新されたときに生成されます。 | /policy/api/v1/infra/domains/<domain>/endpoint-policies/<policy>/endpoint-rules/<rule> |
| service_insertion | サービス挿入モジュールでサポートされている通知。 現在、サービス挿入モジュールは、サービス プロファイル、サービス インスタンス ランタイム、ポリシー グループの通知をサポートしています。 |
instance_runtime_notification | サービス インスタンス ランタイム通知。<service-id> はサービス、<service-instance-id> はサービス インスタンスを表します。展開と展開解除の操作に関する通知が送信されます。 | /api/v1/serviceinsertion/services/<service-id>/service-instances/<service-instance-id>/instance-runtimes |
| profile_notification | サービス プロファイル変更通知。<service-reference> はサービス名、<service-profile> はプロファイル名を表します。プロファイルの作成、更新、削除に関する通知が送信されます。 | /policy/api/v1/infra/service-references/<service-reference>/service-profiles/<service-profile> | ||
| profile_chain_mapping_notification | サービス プロファイル チェーン マッピングの通知。<service-reference> はサービス名、<service-profile> はプロファイル名を表します。通知は、サービス チェーンに対してプロファイルの追加または削除が行われると送信されます。 | /policy/api/v1/infra/service-references/<service-reference>/service-profiles/<service-profile>/service-chain-mappings | ||
| profile_nsgroups_notification | サービス プロファイル NSGroups 通知。<service-reference> はサービス名、<service-profile> はプロファイル名を表します。この通知は、nsgroups を含む East-West ルールが特定のプロファイルで追加または削除されるたびにトリガされます。 | /policy/api/v1/infra/service-references/<service-reference>/service-profiles/<service-profile>/group-associations | ||
| instance_nsgroups_notification | サービス インスタンス NSGroups 通知。<service-id> はサービス名、サービス インスタンスは <service-instance-id> を表します。この通知は、nsgroups を含む North-South ルールが特定のインスタンスで追加または削除されるたびにトリガされます。 | /api/v1/serviceinsertion/services/<service-id>/service-instances/<service-instance-id>/group-associations |
