前のトピック: パラメータ説明次のトピック: Web サービス API をテストする方法


Web サービス メソッド

このセクションでは、Web サービス メソッドについて説明します。

詳細:

エラー レポートの仕組み

InsertNetworkDefinition

目的: ネットワーク定義を作成します。

[環境管理]ページの[ネットワークのプロパティ]内のサブミットされた新しいエントリはそれぞれ、1 つのメソッド コールに相当します。

入力パラメータ:

戻り値: ルート ノード InsertNetworkDefinition、および挿入されたネットワークの新しく作成された ClientId が含まれる ClientId エレメントで構成される XML ドキュメント。 失敗した場合は、ClientId はゼロになります。

返されるエラー: 標準エラー レポートが提供されます。

UpdateNetworkDefinition

目的: 渡されたクライアント ID によって識別されるネットワーク定義を変更します(サブネット説明、IP アドレスおよびマスクを含む)。

[環境管理]ページのネットワーク定義編集はそれぞれ 1 つのメソッド コールに相当します。

入力パラメータ:

戻り値: 更新の成功または失敗を示す true または false。

返されるエラー: 標準エラー レポートが提供されます。

DeleteNetworkDefinition

目的: 渡されたクライアント ID によって識別されるネットワーク定義を削除します。 内部では、クライアント ネットワークは非アクティブとマークされます。 すでに削除されているネットワークを削除すると、false の戻りコードが返されます。

[環境管理]ページでは、[ネットワーク リスト]からネットワークを削除することは 1 つのメソッド コールに相当します。

入力パラメータ: ClientId (必須)

戻り値: ルート ノード DeleteNetworkDefinition、および削除された ClientId が含まれる ClientId エレメントで構成される XML ドキュメント。

返されるエラー: 標準エラー レポートが提供されます。

NetworkDefinitionsList

目的: クライアント ID によってネットワーク定義を取得します。

[環境管理]ページの[ネットワーク リスト]には、デフォルト ネットワーク セットからのすべてのネットワーク定義が含まれます。

入力パラメータ: なし。

戻り値: ネットワーク定義ごとに 1 つのエントリが含まれる XML ドキュメント。 エントリにはそれぞれ以下のパラメータが含まれます。

返されるエラー: 標準エラー レポートが提供されます。

ReloadCollectors

目的: 設定データを選択して再起動するために、すべての 監視デバイス のリセットをトリガします。

[環境管理]ページの[表示項目]メニューで、[データ監視]、[監視デバイス]の順にクリックします。 [ADA 監視デバイス リスト]で、青い歯車型メニュー()をクリックし、[監視デバイスを同期]を選択します。

入力パラメータ: なし

戻り値: ルート ノード ReloadCollectors、および各 監視デバイス のステータス レポート用の Collector エレメントで構成される XML ドキュメント。 Status/Message 属性は、再ロード プロセスの成功を示します。 同期の結果については、各 監視デバイス を個別にチェックしてください。

返されるエラー: 標準エラー レポートが提供されます。

ShowVersion

目的: この API の文字列/数値のバージョン番号を表示します。 このメソッドはこの Web サービス API にのみ適用可能です。

入力パラメータ: なし。

戻り値: 文字列としてのバージョン番号。

返されるエラー: 標準エラー レポートが提供されます。