square.gif 開発者リファレンス

homeicon.gif Print Page Send Comments

Web サービス API

目次 表示

GroundWork 開発者キット (GroundWork Developer's Kit:GDK)

注: エンドユーザやパートナーおよび内部開発者が GroundWork Developer's Kit (GDK) を使って GroundWork Monitor 6.0 プラットフォームを拡張するための情報を入手できる GroundWork Open Source Wiki をアクセスするには、GroundWork MonitorGroundWork GDK メニューオプションを選択してください。

Web サービス API について

Web サービス層を追加することで、より多くのアプリケーションが使用でき、既存の Foundation フレームワークに統合できるようになります。 Web サービス API は SOAP (Simple Object Access Protocol) を通信プロトコルとして使用します。 Web サービス は明確で広く普及している標準なので、.NET などの他の技術や Visual Studio や Java Studio Creator などの人気のある開発ツールで Foundation プラットフォームの上に UI やビジネスコンポーネントを作成するのに使うことができます。

Web サービスフレームワークは以前の API よりも、 API の拡張や配布を容易にします。それにより、高いスループットを得られ、大規模インストレーションでの全体的なパフォーマンスが向上します。アドバンスト・レポート機能は、 Foundation のパーシステント・ストア(持続性記憶)内のデータにアクセスするために Foundation の Web サービス API を使用します。

GroundWork の Web サービス

Web サービス API は SOAP (Simple Object Access Protocol) を通信プロトコルとして使用します。

アプリケーションはエンドポイント(Foundation)からデータを参照したり、問い合わせたりするために Web サービス記述言語(WSDL)ファイルを使います。 SOAP リクエストは WSDL ファイルに基づいています。

Web サービスを使用するために SOAP ライブラリが下記の URL を知る必要があります:

WSDL ファイルのロケーション

http://localhost:8080/foundation-webapp/services/wscommon?wsdl

http://localhost:8080/foundation-webapp/services/wscategory?wsdl

http://localhost:8080/foundation-webapp/services/wsevent?wsdl

http://localhost:8080/foundation-webapp/services/wsdevice?wsdl

http://localhost:8080/foundation-webapp/services/wshost?wsdl

http://localhost:8080/foundation-webapp/services/wshostgroup?wsdl

http://localhost:8080/foundation-webapp/services/wsservice?wsdl

http://localhost:8080/foundation-webapp/services/wsstatistics?wsdl

http://localhost:8080/foundation-webapp/services/wsrrd?wsdl

スキーマ・ファイルのロケーション

http://www.w3.org/2001/XMLSchema

SOAP エンドポイント

http://localhost:8080/foundation-webapp/services/wscommon

http://localhost:8080/foundation-webapp/services/wscategory

http://localhost:8080/foundation-webapp/services/wsevent

http://localhost:8080/foundation-webapp/services/wsdevice

http://localhost:8080/foundation-webapp/services/wshost

http://localhost:8080/foundation-webapp/services/wshostgroup

http://localhost:8080/foundation-webapp/services/wsservice

http://localhost:8080/foundation-webapp/services/wsstatistics

http://localhost:8080/foundation-webapp/services/wsrrd

Foundation の Web サービス API は、下表の Web サービスを提供しています。 GroundWork のための Web サービス記述言語 (WSDL) はエンドポイント(Foundation)からデータを参照したり問い合わせたりするために、アプリケーションによって使用されます。下表の右端のカラムにある .wsdl のリンクをクリックすると、 .pdf ファイル内のコンテンツが表示されます。

表: GroundWork Web サービス

Web サービス

説明

WSDL

カテゴリー

カテゴリーは、エンティティ(サービス、ホスト、ログメッセージ、デバイス)をグループ分けし、階層を作るのに使用します。この Web サービスではカテゴリー(グルーピング)の作成、保守と削除はできますが、エンティティについてはできません。現在のGroundWork バージョンでは サービスグループを管理するのにカテゴリーを使用します。

fwscategory.wsdl

共通

アプリケーションタイプ、ステータスなどのメタデータを問い合わせ、 GroundWork コンソールからのカスタムアクションに使用されるアクション API にアクセスするための Web サービス API 。

fwscommon.wsdl

デバイス

Foundation データベース内のデバイスのエントリを保守する Web サービス。デバイスとは監視のためにアドレス付与可能な基本エンティティです。

fwsdevice.wsdl

イベント

イベント Web サービスは Foundation 内に保存される LogMessage を管理する API です。

fwsevent.wsdl

ホスト

ホスト Web サービスはFoundation 内の Host エンティティを管理する API です。

fwshost.wsdl

ホストグループ

ホストグループ Web サービスは Foundation 内の HostGroup エンティティを管理する API です。 HostGroup は Host エンティティの集合です。

fwshostgroup.wsdl

モデル

Foundation Web サービス API によって使用される基本タイプとオブジェクトを定義します。

fwsmodel.wsdl

RRD

一連の RRD ファイルのためのイメージ(PNG)を問い合わせる Web サービス。 引数のホストだけをつけて Web サービスを呼ぶと、そのホストの全サービスを表示するグラフの配列が返されます。ホスト名/サービス説明(Host name/Service description)を送ると、特定のグラフが返されます。

fwsrrd.wsdl

サービス

サービス Web サービスは Foundation 内のすべての ServiceStatus オブジェクトを管理する API です。

fwsservice.wsdl

統計

Foundation は実行中に Host/HostGroup と Service/ServiceGroup データの現在状態についての統計を生成します。この Web サービスは、このランタイムデータにアクセスするいくつかの方法を提供します。

fwsstatistics.wsdl

Web サービス - メソッド

getServiceAvailabilityForHostgroup ( hostGroupName )

入力: hostGroupName = サービスの稼動率(パーセンテージ)を問い合わせるためのホストグループの名前を定義する文字列。

戻り:指定されたホストグループ内のサービスが OK (正常)ステータスであったパーセンテージの数(double 型)。

getHostAvailabilityForHostgroup ( hostGroupName )

入力: hostGroupName = ホストの稼動率(パーセンテージ)を問い合わせるためのホストグループの名前を定義する文字列。

戻り: 指定されたホストグループ内のホストが UP(稼動)ステータスであったパーセンテージの数(double 型)。