このセクションでは、ドットコムモニター監視ツールを使用してアプリケーションを開発するソフトウェア開発者を支援します。
Dotcom-Monitor Web サイト インターフェイスを超えて監視データを表示および操作するには、XML フィードを使用してデータを消費したり、Dotcom-Monitor API を操作してインストールされている監視エージェントを監視および更新したりするなど、いくつかの方法があります。
XML フィードを使用すると、開発者は必要なデータをサブスクライブし、独自のカスタム レポートを使用して独自の形式で表示できます。 詳細については 、「XML レポート サービス (XRS) ツールの使用 」を参照してください。
Dotcom-Monitor API ユーザーは、独自のカスタム スクリプトまたはアプリケーションを作成して、設定を操作し、独自のカスタマイズされた環境で監視対象データを表示できます。 当社のシステムは、HTTP(S) 要求 (GET、POST、PUT、DELETE) を介してデータを操作するための最も一般的なメソッドを使用して、プログラムで Dotcom-Monitor Web サイトとの対話を可能にする REST API を使用します。 ほとんどすべてのドットコムモニタオブジェクトはREST APIを介してアクセスでき、ドットコムモニタサービス機能のほぼすべての側面を管理することができます。 API 呼び出しを使用すると、デバイスやタスクの作成と削除、延期と開始、アラート グループ、テンプレート、フィルター、スケジューラの作成と管理、デバイスの状態情報、およびその他の多くのオプションを取得できます。
一般に、ドットコムモニタ API は次のタスクで使用できます。
- ドットコムモニタ監視ソリューションとのサードパーティ統合。
- データのダウンロードとアップロード。
- データの変更。
REST API を使用して実行される最も一般的なアクション:
- 監視プラットフォーム、デバイス、ターゲット、スケジューラ、ロケーション、アラートグループ、フィルタ、アラートテンプレートのリストにアクセスする。
- プラットフォーム、デバイス、ターゲットに関する詳細情報にアクセスする。
- デバイス、ターゲット、スケジューラ、アラートグループ、テンプレート、フィルタの編集。
- 新しいドットコムモニタオブジェクト(デバイス、ターゲット、スケジューラなど)を作成します。
- 監査オブジェクトの管理。
ドットコムモニタ API は、10 種類のリソースに分かれています。
- プラットフォーム: すべての監視タスクは、5 つの異なるプラットフォームのいずれかに分類されます。
- デバイス: 監視対象デバイスは、単一の監視タスク、一連の監視タスク、タスクを含む監視スクリプト、または 3 つのタスクの組み合わせを含む監視タスクの整理された”セット”です。
- タスク: タスクとは、ターゲット (URL、メール サーバー、FTP サーバーなど) の監視など、任意の単一の監視アクティビティです。
- 周波数: 監視セッションを実行する頻度を定義します。
- スケジューラ: スケジューラーは、タスクがいつ実行されるか、実行されないかの詳細です。
- 場所: Dotcom-Monitor の世界規模の監視ネットワーク内で利用可能な監視場所。
- アラート グループ: グループを設定すると、レポートやアラートの受信者がグループに配置されます。 グループ内の各受信者は、固有の通知テンプレートを持つことができます。
- アラート テンプレート: テンプレートは、アラートの形式を定義します。
- フィルタ: フィルターは、監視応答の処理方法と表示方法を決定する一連のルールです。
- 監査: 各アカウントの変更に関する履歴情報を提供します。
次の表は、各リソースの種類でサポートされている要求の種類とアクションを示しています。 詳細については 、「監視方法 」セクションを参照してください。
リソースの種類 | リクエスト方法 | URI (秒) | 形容 |
---|---|---|---|
プラットホーム | 取得 | /プラットフォーム | 利用可能なプラットフォームの一覧を返す |
デバイス | 取得 | /デバイス/{platform} | プラットフォームごとにデバイスリストを取得します。 |
取得 | /デバイス/{deviceId} | デバイス情報の取得 | |
投稿 | /devices?verb=入れる | 新しいデバイスの作成 | |
置く | /デバイス | ||
投稿 | /device/{deviceId}/DisableAlert/ | アラートを無効にする | |
投稿 | /デバイス/{deviceId} | デバイスの編集 | |
投稿 | /device/{deviceId}?verb=delete | デバイスを削除 | |
削除 | /デバイス/{deviceId} | ||
タスク | 取得 | /device/{deviceid}/tasks | デバイス配下のタスクの一覧を取得する |
投稿 | /tasks?verb=置く | 新しいタスクを作成 | |
置く | /用事 | ||
取得 | /タスク/{TaskId} | タスク情報を取得する | |
投稿 | /タスク/{TaskId} | タスクの編集 | |
投稿 | /task/{TaskId}?verb=delete | タスクの削除 | |
削除 | /タスク/{TaskId} | ||
周波数 | 取得 | /frequencies/{platform_name} | 利用可能なfreqを取得します。 プラットフォーム別。 |
スケジューラ | 取得 | /スケジューラ | スケジューラの一覧を取得する |
取得 | /スケジューラ/{Scheduler_ID} | 特定のスケジューラ情報を取得する | |
投稿 | /schedulers?verb=置く | 新しいスケジューラを作成する | |
置く | スケジューラ | ||
投稿 | /scheduler/{ スケジューラ ID} | スケジューラの編集 | |
投稿 | /scheduler/{Scheduler_Id}?verb=delete | スケジューラを削除 | |
削除 | /スケジューラ/{Scheduler_Id} | ||
場所 | 取得 | /場所/{platform_name} | 利用可能な場所のリストを取得する |
アラート グループ | 取得 | /グループ | アラート グループの一覧を取得する |
投稿 | /groups?verb=PUT/groups | アラート グループの作成 | |
置く | グループ/グループ | ||
取得 | /群/{Group_ID} | アラート グループ情報の取得 | |
投稿 | /群/{Group_ID} | アラート グループの編集 | |
投稿 | /group/{Group_Id}?verb=delete | グループを削除 | |
削除 | 群/{Group_Id} | ||
アラート テンプレート | 取得 | /テンプレート | アラート テンプレートの一覧を取得する |
投稿 | /templates?verb=PUT/テンプレート | 新しいアラート テンプレートを作成する | |
置く | /テンプレート/テンプレート | ||
取得 | /テンプレート/{Template_ID} | アラート テンプレート情報を取得する | |
投稿 | /テンプレート/{Template_ID} | アラートテンプレートの編集 | |
投稿 | /template/{Template_Id}?verb=delete | テンプレートを削除 | |
削除 | /テンプレート/{Template_Id} | ||
フィルター | 取得 | /フィルター | フィルターの一覧を取得する |
投稿 | /filters?verb=PUT | 新しいフィルターの作成 | |
置く | /フィルター | ||
取得 | /フィルター/{filter_ID} | 特定のフィルター情報を取得する | |
投稿 | /フィルター/{filter_ID} | フィルターの編集 | |
投稿 | /filter/{filter_ID}?verb=delete | フィルターを削除 | |
削除 | /フィルター/{filter_ID} | ||
監査 | 取得 | /監査/リスト | 過去 24 時間の現在のユーザーの監査対象オブジェクトを一覧表示します。 |
取得 | /audit/object/{サンプル ID} | 特定の ID の監査の内容を取得する | |
投稿 | /監査/リスト | 監査対象オブジェクトのフィルタリングされたリストを取得します。 |