状況ステータス情報の取得
これらの例は、状況ステータス情報の取得方法を示しています。 現在のステータスに関する情報を取得したり、ステータスの履歴を取得したりすることができます。
- 現在の状況のステータス情報を取得するには、
GET /situations/statusエンドポイントを使用します。 詳細は 、「現状ステータスのリクエスト」 を参照してください。 - 状況の履歴を取得するには、
GET /situations/status/historyエンドポイントを使用します。 詳細については 、「状況ステータスの履歴をリクエストする 」を参照してください。
特定の状況ステータスの属性をリクエストに含めることで、結果をフィルタリングすることができます。 詳細については 、「属性によるフィルタリング結果 」を参照してください。
注:リモートモニタリングサーバ(RTEMS)へのリクエストは、リモートモニタリングサーバからの状況情報を返します。 ハブ監視サーバ(ハブTEMS)に問い合わせが送信されると、ハブTEMSとRTEMSの両方の情報を返します。
現在の状況について問い合わせる
現在の状況 ステータス 属性 実行中の状況やポリシーに関するステータス情報を収集します。
現在の状況のステータス情報を取得するには、
GET /situations/status エンドポイントを次のように使用します- 定義されたすべての状況の現在のステータスを要求するには、以下のパスを使用する:
このリクエストの結果は、定義されたすべての状況の現在のステータスのリストです。https://host:port/api/v1/situations/status - 特定のシチュエーションのステータスを要求するには、そのシチュエーションまたはポリシーに与えられた一意の識別子を設定した「nameパラメータを含める:
このリクエストの結果は、指定された状況のステータスのみである。 デフォルトでは、その状況の結果は応答に含まれません。https://host:port/api/v1/situations/status?name=situation_name状況ステータスの結果を取得するには、 includeResults パラメータを含め、trueに設定しますhttps://host:port/api/v1/situations/status?name=situation_name&includeResults=true注:trueに設定された includeResults パラメータを使用するには、リクエストで name または originnode パラメータも指定する必要がある。 - また、以下の例のように、さまざまな属性で結果をフィルタリングすることもできます
https://host:port/api/v1/situations/status?node=node_namehttps://host:port/api/v1/situations/status?originnode=origin_node_namehttps://host:port/api/v1/situations/status?atomize=display_item
必要に応じて、属性クエリパラメータを単一のリクエストにまとめることができます。 詳細については 、「属性によるフィルタリング結果 」を参照してください。https://host:port/api/v1/situations/status?deltastat=situation_status
状況のステータス履歴をリクエストする
状況の履歴を取得するには、 GET /situations/status/history エンドポイントを使用します。
このエンドポイントを使用する際には、履歴を取得する時刻を指定する必要があります。必要な時間値クエリパラメータ timeFrom とオプションのパラメータ timeTill を含める必要があります。 時間値パラメータの使用方法の詳細については 、「リクエストにおける時間値の使用 」を参照してください。
以下の例は、状況ステータスの履歴を取得する方法を示しています
- 特定の時間以降に定義されたすべての状況のステータス履歴をリクエストするには、以下のパスを使用します
このリクエストの結果は、指定した時点からのすべての定義された状況のステータス履歴のリストです。https://host:port/api/v1/situations/status/history?timeFrom=YYYMMDDHHMMSS終了時刻を含めるには、リクエストに timeTill パラメータを含めますhttps://host:port/api/v1/situations/status/history?timeFrom=YYYMMDDHHMMSS&timeTill=YYYMMDDHHMMSS - 特定の状況のステータス履歴をリクエストするには、 name パラメータに、その状況またはポリシーに割り当てられた固有の識別子を設定します
このリクエストの結果は、指定された状況のステータス履歴です。 デフォルトでは、その状況の結果は応答に含まれません。https://host:port/api/v1/situations/status/history?name=situation_name&timeFrom=YYYMMDDHHMMSS状況ステータスの結果を取得するには、 includeResults パラメータを含め、trueに設定しますhttps://host:port/api/v1/situations/status/history?name=situation_name&timeFrom=YYYMMDDHHMMSS&includeResults=true注:trueに設定された includeResults パラメータを使用するには、リクエストで name または originnode パラメータも指定する必要がある。 - また、以下の例のように、さまざまな属性で結果をフィルタリングすることもできます
https://host:port/api/v1/situations/status/history?timeFrom=YYYMMDDHHMMSS&node=node_namehttps://host:port/api/v1/situations/status/history?timeFrom=YYYMMDDHHMMSS&originnode=origin_node_namehttps://host:port/api/v1/situations/status/history?timeFrom=YYYMMDDHHMMSS&atomize=display_item
必要に応じて、属性クエリパラメータを単一のリクエストにまとめることができます。 詳細については 、「属性によるフィルタリング結果 」を参照してください。https://host:port/api/v1/situations/status/history?timeFrom=YYYMMDDHHMMSS&deltastat=situation_status
結果を属性でフィルタリングする
GET /situations/status または GET /situations/status/history を使用して状況ステータス情報を要求する際には、クエリパラメータを使用して指定した利用可能な属性によって結果をフィルタリングすることができます。
以下の表は、リクエストのフィルタリングに使用できる属性のクエリパラメータについて説明し、 Tivoli Enterprise Portal (TEP)における属性の関連する場所も提供しています
| パラメーター | 説明 | TEP内の位置 |
|---|---|---|
| name | 状況名。 状況または方針に割り当てられた一意の識別子。 | メッセージログ表示、 名前フィールド |
| node | ノード。 状況が配信および監視される管理システムの名称。 システム上のすべてのノードに関する情報を取得するには、 /system/nodes を使用してください。 |
メッセージログ表示 、ノードフィールド |
| originnode | 起点ノード。 状況がトリガーされた管理システムの名前。 システム上のすべてのノードに関する情報を取得するには、 /system/nodes を使用してください。 |
メッセージログ表示 、Origin Node フィールド |
| atomize | アイテムを表示する。 複数行の属性グループの場合、この属性により、データサンプリングおよびオープンイベントで、すべての行をテストし続けることができます。 主式で指定され、ATOMIZEの対象となるテーブルの列のみが処理されます。 例えば、以下の仕様では、 REALTHDA テーブルから ATOMIZE の対象となる列のみが結果に含まれるよう要求しています
ヒント:
GET /system/tables?name=REALTHDA エンドポイントを使用して、 "ATOMIZE":
true で示されているように、ATOMIZEの対象となる列を特定することができます。 |
メッセージログ表示 、表示項目フィールド |
| deltastat | シチュエーション状況。 考えられる値は以下のとおりです。
|
メッセージログ表示、 ステータスフィールド |