Red Hat Summit6.75. Events
システムのイベントを管理するサービス。
| 名前 | Summary |
|---|---|
|
| 外部イベントを内部監査ログに追加します。 |
|
| イベントのリストを取得します。 |
|
|
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>
イベントは特定のオブジェクトにリンクすることもできます。たとえば、上記のイベントは、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>
前述の例の vm のようにリンクを使用する場合は、id 属性のみが許可されます。name 属性 (指定されている場合) は無視されます。
| 名前 | 型 | 方向 | Summary |
|---|---|---|---|
|
| In/Out |
6.75.2. list GET
イベントのリストを取得します。
GET /ovirt-engine/api/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>以下のイベントが発生します。
- id="1": 管理ユーザーアカウントの API ログイン。
- id="2": API は admin ユーザーアカウントからログアウトします。
返されるイベントのリストの順序は常に付与されます。sortby 句が search パラメーターに含まれている場合、イベントはその句に従って順序付けられます。sortby 句が含まれていない場合、イベントは id 属性の値でソートされ、値は最も高いものから順に並べ替えられます。これは、max パラメーターと組み合わせて、最新のイベントの取得を簡素化します。
GET /ovirt-engine/api/events?max=1| 名前 | 型 | 方向 | Summary |
|---|---|---|---|
|
| In |
| |
|
| Out | ||
|
| In | たどる 必要のある内部リンクを指定します。 | |
|
| In | イベントを返すまでのイベントインデックスを示します。 | |
|
| In | 返すイベントの最大数を設定します。 | |
|
| 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このパラメーターは任意です。指定されていない場合には、返される最初のイベントが最後に生成されます。
6.75.2.4. max
返すイベントの最大数を設定します。指定されていない場合は、すべてのイベントが返されます。
6.75.2.5. search
イベントサービスは、他のリソースサービスと同様に検索クエリーを提供します。
特定の重大度を指定して検索できます。
GET /ovirt-engine/api/events?search=severity%3Dnormal
上記のリクエストに対して、重大度が 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>仮想化環境は、一定期間後に大量のイベントを生成します。ただし、API は 1 つの検索クエリーのデフォルトイベントのみを表示します。デフォルト以外のものを表示するには、API は結果を検索クエリーで page コマンドを使用してページに分割します。次の検索クエリーは、sortby 句と組み合わせてページ値を使用して結果をページ分割するように API に指示します。
sortby time asc page 1以下の例は、イベントリソースをページ分割します。URL でエンコードされたリクエストは以下のとおりです。
GET /ovirt-engine/api/events?search=sortby%20time%20asc%20page%201ページ値を増やして、結果の次のページを表示します。
GET /ovirt-engine/api/events?search=sortby%20time%20asc%20page%2026.75.3. undelete POST
| 名前 | 型 | 方向 | Summary |
|---|---|---|---|
|
| In | 削除解除を非同期的に実行するかどうかを示します。 |
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}