6.74. EventSubscriptions
ユーザーのイベントサブスクリプションのコレクションを管理するサービスを表します。
名前 | Summary |
---|---|
| システムに新しい event-subscription を追加します。 |
| 提供されたユーザーの event-subscriptions をリスト表示します。 |
6.74.1. add POST
システムに新しい event-subscription を追加します。
event-subscription は、ユーザーのコンテキストに常に追加されます。たとえば、ユーザー 123
の host_high_cpu_use
に新しい event-subscription を追加し、通知を電子メールアドレス a@b.com
に送信するには、以下のようなリクエストを送信します。
POST /ovirt-engine/api/users/123/eventsubscriptions
リクエスト本文は以下のようになります。
<event_subscription> <event>host_high_cpu_use</event> <address>a@b.com</address> </event_subscription>
イベント名は新しい event-subscription エンティティーの ID になります (GET …/api/users/123/eventsubscriptions/host_high_cpu_use)。
要求の本文にはユーザー ID が指定されないことに注意してください。これは、ユーザー ID(この場合は 123) がコンテキストから API にすでに認識されているためです。また、event-subscription エンティティーには notification-method フィールドが含まれていますが、リクエスト本文にも提供されていないことにも注意してください。これは、SNMP 通知が API レイヤーでまだサポートされていないため、現在は常に SMTP に設定されているためです。
名前 | 型 | 方向 | Summary |
---|---|---|---|
| In/Out | 追加された event-subscription。 |
6.74.2. list GET
提供されたユーザーの event-subscriptions をリスト表示します。
たとえば、ユーザー 123
の event-subscriptions をリスト表示するには、以下を実行します。
GET /ovirt-engine/api/users/123/event-subscriptions
<event-subscriptions> <event-subscription href="/ovirt-engine/api/users/123/event-subscriptions/host_install_failed"> <event>host_install_failed</event> <notification_method>smtp</notification_method> <user href="/ovirt-engine/api/users/123" id="123"/> <address>a@b.com</address> </event-subscription> <event-subscription href="/ovirt-engine/api/users/123/event-subscriptions/vm_paused"> <event>vm_paused</event> <notification_method>smtp</notification_method> <user href="/ovirt-engine/api/users/123" id="123"/> <address>a@b.com</address> </event-subscription> </event-subscriptions>
名前 | 型 | 方向 | Summary |
---|---|---|---|
| Out | 指定されたユーザーの event-subscriptions のリスト | |
| In | たどる 必要のある内部リンクを指定します。 | |
| In | 返すイベントサブスクリプションの最大数を設定します。 |
6.74.2.1. follow
たどる 必要のある内部リンクを指定します。これらのリンクで参照されるオブジェクトは、現在の要求の一部としてフェッチされます。詳細は、こちら を参照してください。
6.74.2.2. max
返すイベントサブスクリプションの最大数を設定します。指定されていない場合は、event-subscriptions がすべて返されます。