您可以注册将根据特定条件接收通知的监视程序。

要注册监视程序,您可以调用以下 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。
功能名称 功能描述 通知名称 通知描述 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 服务配置文件 NS 组通知。<service-reference> 标识服务名称,<service-profile> 标识配置文件名称。每当使用特定配置文件添加或删除包含 NS 组的东西向规则时,便会触发此通知。 /policy/api/v1/infra/service-references/<service-reference>/service-profiles/<service-profile>/group-associations
instance_nsgroups_notification 服务实例 NS 组通知。<service-id> 标识服务名称,<service-instance-id> 标识服务实例。每当使用特定实例添加或删除包含 NS 组的南北向规则时,便会触发此通知。 /api/v1/serviceinsertion/services/<service-id>/service-instances/<service-instance-id>/group-associations