6.75. Events

システムのイベントを管理するサービス。

Expand

表6.220 メソッドの概要
名前	Summary
`add`	外部イベントを内部監査ログに追加します。
`list`	イベントのリストを取得します。
`undelete`

6.75.1. add POST
リンクのコピー

外部イベントを内部監査ログに追加します。

これは、システムの管理者に関連するイベントを検出または生成する外部システムとの統合を目的としています。たとえば、外部監視ツールは、仮想マシンのゲストオペレーティングシステム内でファイルシステムがいっぱいであることを検出できる場合があります。このイベントは、以下のような要求を送信する内部監査ログに追加できます。

POST /ovirt-engine/api/events
<event>
  <description>File system /home is full</description>
  <severity>alert</severity>
  <origin>mymonitor</origin>
  <custom_id>1467879754</custom_id>
</event>

POST /ovirt-engine/api/events
<event>
  <description>File system /home is full</description>
  <severity>alert</severity>
  <origin>mymonitor</origin>
  <custom_id>1467879754</custom_id>
</event>

Copy to Clipboard

Toggle word wrap

イベントは特定のオブジェクトにリンクすることもできます。たとえば、上記のイベントは、vm リンクを使用して、発生した特定の仮想マシンにリンクできます。

POST /ovirt-engine/api/events
<event>
  <description>File system /home is full</description>
  <severity>alert</severity>
  <origin>mymonitor</origin>
  <custom_id>1467879754</custom_id>
  <vm id="aae98225-5b73-490d-a252-899209af17e9"/>
</event>

POST /ovirt-engine/api/events
<event>
  <description>File system /home is full</description>
  <severity>alert</severity>
  <origin>mymonitor</origin>
  <custom_id>1467879754</custom_id>
  <vm id="aae98225-5b73-490d-a252-899209af17e9"/>
</event>

Copy to Clipboard

Toggle word wrap

注記

前述の例の vm のようにリンクを使用する場合は、id 属性のみが許可されます。name 属性 (指定されている場合) は無視されます。

Expand

表6.221 パラメーターの概要
名前	型	方向	Summary
`event`	イベント	In/Out

6.75.2. list GET
リンクのコピー

イベントのリストを取得します。

GET /ovirt-engine/api/events

GET /ovirt-engine/api/events

Copy to Clipboard

Toggle word wrap

上記のリクエストに対して、以下のレスポンスを受け取ります。

<events>
  <event href="/ovirt-engine/api/events/2" id="2">
    <description>User admin@internal-authz logged out.</description>
    <code>31</code>
    <correlation_id>1e892ea9</correlation_id>
    <custom_id>-1</custom_id>
    <flood_rate>30</flood_rate>
    <origin>oVirt</origin>
    <severity>normal</severity>
    <time>2016-09-14T12:14:34.541+02:00</time>
    <user href="/ovirt-engine/api/users/57d91d48-00da-0137-0138-000000000244" id="57d91d48-00da-0137-0138-000000000244"/>
  </event>
  <event href="/ovirt-engine/api/events/1" id="1">
    <description>User admin logged in.</description>
    <code>30</code>
    <correlation_id>1fbd81f4</correlation_id>
    <custom_id>-1</custom_id>
    <flood_rate>30</flood_rate>
    <origin>oVirt</origin>
    <severity>normal</severity>
    <time>2016-09-14T11:54:35.229+02:00</time>
    <user href="/ovirt-engine/api/users/57d91d48-00da-0137-0138-000000000244" id="57d91d48-00da-0137-0138-000000000244"/>
  </event>
</events>

<events>
  <event href="/ovirt-engine/api/events/2" id="2">
    <description>User admin@internal-authz logged out.</description>
    <code>31</code>
    <correlation_id>1e892ea9</correlation_id>
    <custom_id>-1</custom_id>
    <flood_rate>30</flood_rate>
    <origin>oVirt</origin>
    <severity>normal</severity>
    <time>2016-09-14T12:14:34.541+02:00</time>
    <user href="/ovirt-engine/api/users/57d91d48-00da-0137-0138-000000000244" id="57d91d48-00da-0137-0138-000000000244"/>
  </event>
  <event href="/ovirt-engine/api/events/1" id="1">
    <description>User admin logged in.</description>
    <code>30</code>
    <correlation_id>1fbd81f4</correlation_id>
    <custom_id>-1</custom_id>
    <flood_rate>30</flood_rate>
    <origin>oVirt</origin>
    <severity>normal</severity>
    <time>2016-09-14T11:54:35.229+02:00</time>
    <user href="/ovirt-engine/api/users/57d91d48-00da-0137-0138-000000000244" id="57d91d48-00da-0137-0138-000000000244"/>
  </event>
</events>

Copy to Clipboard

Toggle word wrap

以下のイベントが発生します。

id="1": 管理ユーザーアカウントの API ログイン。
id="2": API は admin ユーザーアカウントからログアウトします。

返されるイベントのリストの順序は常に付与されます。sortby 句が search パラメーターに含まれている場合、イベントはその句に従って順序付けられます。sortby 句が含まれていない場合、イベントは id 属性の値でソートされ、値は最も高いものから順に並べ替えられます。これは、max パラメーターと組み合わせて、最新のイベントの取得を簡素化します。

GET /ovirt-engine/api/events?max=1

GET /ovirt-engine/api/events?max=1

Copy to Clipboard

Toggle word wrap

Expand

表6.222 パラメーターの概要
名前	型	方向	Summary
`case_sensitive`	ブール値	In	`search` パラメーターを使用して実行する検索を、大文字と小文字を区別して実行する必要があるかどうかを示します。
`events`	Event[]	Out
`follow`	String	In	たどる必要のある内部リンクを指定します。
`from`	Integer	In	イベントを返すまでのイベントインデックスを示します。
`max`	Integer	In	返すイベントの最大数を設定します。
`search`	String	In	イベントサービスは、他のリソースサービスと同様に検索クエリーを提供します。

6.75.2.1. case_sensitive
リンクのコピー

search パラメーターを使用して実行する検索を、大文字と小文字を区別して実行する必要があるかどうかを示します。デフォルト値は true です。つまり、大文字と小文字の区別が考慮されます。ケースを無視する場合は、false に設定します。

6.75.2.2. follow
リンクのコピー

たどる 必要のある内部リンクを指定します。これらのリンクで参照されるオブジェクトは、現在の要求の一部としてフェッチされます。詳細は、こちらを参照してください。

6.75.2.3. from
リンクのコピー

イベントを返すまでのイベントインデックスを示します。イベントのインデックスは厳密に増加されるため、このパラメーターを使用すると、より大きなインデックスを持つイベントのみが返されます。たとえば、以下のリクエストは 123 を超えるインデックスのイベントのみを返します。

GET /ovirt-engine/api/events?from=123

GET /ovirt-engine/api/events?from=123

Copy to Clipboard

Toggle word wrap

このパラメーターは任意です。指定されていない場合には、返される最初のイベントが最後に生成されます。

6.75.2.4. max
リンクのコピー

返すイベントの最大数を設定します。指定されていない場合は、すべてのイベントが返されます。

6.75.2.5. search
リンクのコピー

イベントサービスは、他のリソースサービスと同様に検索クエリーを提供します。

特定の重大度を指定して検索できます。

GET /ovirt-engine/api/events?search=severity%3Dnormal

GET /ovirt-engine/api/events?search=severity%3Dnormal

Copy to Clipboard

Toggle word wrap

上記のリクエストに対して、重大度が normal と等しいイベントのリストを取得します。

<events>
  <event href="/ovirt-engine/api/events/2" id="2">
    <description>User admin@internal-authz logged out.</description>
    <code>31</code>
    <correlation_id>1fbd81f4</correlation_id>
    <custom_id>-1</custom_id>
    <flood_rate>30</flood_rate>
    <origin>oVirt</origin>
    <severity>normal</severity>
    <time>2016-09-14T11:54:35.229+02:00</time>
    <user href="/ovirt-engine/api/users/57d91d48-00da-0137-0138-000000000244" id="57d91d48-00da-0137-0138-000000000244"/>
  </event>
  <event href="/ovirt-engine/api/events/1" id="1">
    <description>Affinity Rules Enforcement Manager started.</description>
    <code>10780</code>
    <custom_id>-1</custom_id>
    <flood_rate>30</flood_rate>
    <origin>oVirt</origin>
    <severity>normal</severity>
    <time>2016-09-14T11:52:18.861+02:00</time>
  </event>
</events>

<events>
  <event href="/ovirt-engine/api/events/2" id="2">
    <description>User admin@internal-authz logged out.</description>
    <code>31</code>
    <correlation_id>1fbd81f4</correlation_id>
    <custom_id>-1</custom_id>
    <flood_rate>30</flood_rate>
    <origin>oVirt</origin>
    <severity>normal</severity>
    <time>2016-09-14T11:54:35.229+02:00</time>
    <user href="/ovirt-engine/api/users/57d91d48-00da-0137-0138-000000000244" id="57d91d48-00da-0137-0138-000000000244"/>
  </event>
  <event href="/ovirt-engine/api/events/1" id="1">
    <description>Affinity Rules Enforcement Manager started.</description>
    <code>10780</code>
    <custom_id>-1</custom_id>
    <flood_rate>30</flood_rate>
    <origin>oVirt</origin>
    <severity>normal</severity>
    <time>2016-09-14T11:52:18.861+02:00</time>
  </event>
</events>

Copy to Clipboard

Toggle word wrap

仮想化環境は、一定期間後に大量のイベントを生成します。ただし、API は 1 つの検索クエリーのデフォルトイベントのみを表示します。デフォルト以外のものを表示するには、API は結果を検索クエリーで page コマンドを使用してページに分割します。次の検索クエリーは、sortby 句と組み合わせてページ値を使用して結果をページ分割するように API に指示します。

sortby time asc page 1

sortby time asc page 1

Copy to Clipboard

Toggle word wrap

以下の例は、イベントリソースをページ分割します。URL でエンコードされたリクエストは以下のとおりです。

GET /ovirt-engine/api/events?search=sortby%20time%20asc%20page%201

GET /ovirt-engine/api/events?search=sortby%20time%20asc%20page%201

Copy to Clipboard

Toggle word wrap

ページ値を増やして、結果の次のページを表示します。

GET /ovirt-engine/api/events?search=sortby%20time%20asc%20page%202

GET /ovirt-engine/api/events?search=sortby%20time%20asc%20page%202

Copy to Clipboard

Toggle word wrap

6.75.3. undelete POST
リンクのコピー

Expand

表6.223 パラメーターの概要
名前	型	方向	Summary
`async`	ブール値	In	削除解除を非同期的に実行するかどうかを示します。

トップに戻る

6.75. Events

6.75.1. add POST
リンクのコピー

6.75.2. list GET
リンクのコピー

6.75.2.1. case_sensitive
リンクのコピー

6.75.2.2. follow
リンクのコピー

6.75.2.3. from
リンクのコピー

6.75.2.4. max
リンクのコピー

6.75.2.5. search
リンクのコピー

6.75.3. undelete POST
リンクのコピー

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

多様性を受け入れるオープンソースの強化

会社概要

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

6.75. Events

6.75.1. add POSTリンクのコピーリンクがクリップボードにコピーされました!

6.75.2. list GETリンクのコピーリンクがクリップボードにコピーされました!

6.75.2.1. case_sensitiveリンクのコピーリンクがクリップボードにコピーされました!

6.75.2.2. followリンクのコピーリンクがクリップボードにコピーされました!

6.75.2.3. fromリンクのコピーリンクがクリップボードにコピーされました!

6.75.2.4. maxリンクのコピーリンクがクリップボードにコピーされました!

6.75.2.5. searchリンクのコピーリンクがクリップボードにコピーされました!

6.75.3. undelete POSTリンクのコピーリンクがクリップボードにコピーされました!

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

多様性を受け入れるオープンソースの強化

会社概要

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

6.75.1. add POST
リンクのコピー

6.75.2. list GET
リンクのコピー

6.75.2.1. case_sensitive
リンクのコピー

6.75.2.2. follow
リンクのコピー

6.75.2.3. from
リンクのコピー

6.75.2.4. max
リンクのコピー

6.75.2.5. search
リンクのコピー

6.75.3. undelete POST
リンクのコピー