Product Documentation

Monitor Service OData API

Mar 25, 2016
管理者は、Citrix Directorのコンソールで表示した履歴データを、Monitor ServiceのAPIを使って照会できます。 このAPIを使用すると、次の操作を行えます。
  • 将来の計画のために履歴傾向を分析する。
  • 接続やマシンの障害に対する詳細なトラブルシューティングを実行する。
  • ほかのツールおよびプロセスに情報をインポートする(Microsoft ExcelのPowerPivotテーブルを使って別の方法でデータを表示するなど)。
  • APIで提供されるデータ上にカスタムユーザーインターフェイスを構築する。

Monitor Service APIではOpen Data(OData)プロトコルが使用されます。これはデータを照会および更新するためのWebプロトコルで、HTTPなどのWebテクノロジーに基づいています。 ODataプロトコルについて詳しくは、http://www.odata.org.を参照してください。

Monitor Service APIは、処理および統合時に読み込まれるWindows Communication Foundation(WCF)Data Servicesを使用して、SQL Serverデータベース上に構築されます。 WCFを使用して2つのエンドポイントがwsHttpBindingで公開されます。 ベースアドレスは「http://{dc-host}/Citrix/Monitor/OData/v2」です。 また、TLSを使ってエンドポイントを保護することもできます。詳しくは、「TLSを使ったエンドポイントのセキュリティ保護」を参照してください。
  1. Dataエンドポイントは、データベースエンティティへの直接読み取り専用アクセスを公開し、ODataクエリ言語を使用してアクセスすることができます。 このエンドポイントは、フィルタリングおよび列の選択により高度に柔軟なアクセスを実行できます。 Data APIのURIは「http://{dc-host}/Citrix/Monitor/OData/v2/Data」です。 Monitor Serviceデータへのアクセスについて詳しくは、「APIを使ったデータアクセス」を参照してください。
  2. Methodsエンドポイントは、[ダッシュボード]ページや[傾向]ページでの照会など、Citrix Directorで複雑なグループ化や高性能な標準を必要とするデータを取得するためのサービス操作を公開します。 Methods APIのURIは「http://{dc-host}/Citrix/Monitor/OData/v2/Methods」です。 MethodsはDirectorでのみ使用され、通常Citrix製品の管理者やユーザーが使用することはありません。 したがって、ここでは説明しません。

このリリースでの新機能

XenApp/XenDesktop 7.6に付属のAPIにより、以下の新機能が提供されます。
  • Hotfixインベントリ。 Directorの[ユーザーの詳細]ビューまたは[マシン]ビューを使用すると、マシンにインストールされているCitrix Hotfixの一覧を表示できます。 このAPIを使用すると、このデータを抽出してカスタムレポート(サイト全体でインストールされているHotfixの状態など)を作成したり、分析エンジンに取り込んだりできます。 いくつかのクラスが追加され、MachineクラスにControllerやVDAにインストールされたCitrix Hotfixの追跡機能が追加されました。
  • 匿名セッションのトラブルシューティング。 プールされたローカルユーザーアカウントのセットを使用してセッションを実行できます。 このAPIでは、Sessionクラスに新しいIsAnonymousプロパティ(デフォルト値:FALSE)が追加されています。
  • ホストされるアプリケーションの使用量レポート。 Directorでは、ホストされるアプリケーションの経時的な使用状況を示すキャパシティレポートが提供されます。 このAPIを使用すると、ユーザーセッションで実行されている各アプリケーションインスタンスの詳細をレポートできます。

このAPIの新機能について詳しくは、http://support.citrix.com/help/monitorserviceapi/7.6/のAPIリファレンスを参照してください。

GetSessionSummaryメソッドは、このリリースでは廃止されました。