REST API

Applications ManagerはRESTスタイルのAPIでデータの取得をサポートしており、Applications Managerから入手したデータは、お客さま内部ポータルやサード パーティの管理ソフトウェアに統合可能です。データは単一ダッシュボードに表示できます。

APIで必要な形式でHTTPリクエストを行うには、スクリプト言語、Java、C、Perl、PythonなどによるXMLパーサーをご利用ください。APIで取得したデータは、お客さまデータベースに投入したり、必要フォーマットに変換したりできます。

要件

Applications Managerユーザー アカウント

APIを利用するには、有効なユーザー名が必要です。

イントラネットのポータルを例に考えると、ユーザーがログインするごとに、ユーザーとユーザー ロールに対応する監視やアラートが表示されます。そのため、ユーザーごとにAPIキーは別個のものにするのが必須です。GetAlarms APIを特定オペレーター向きのキーで実行した場合は、そのオペレーターに割り当てられているアラートだけが取得されます。

APIのしくみ

APIを利用するには、ユーザーごとにAPIキーを取得してください。APIキーは長いテキスト文字列で、Applications Managerアカウントごとに固有で決まります。APIキーはAPIリクエストの実行ごとに、パラメーターに引き渡す必要があります。

APIキーの作成

APIキーは管理タブの「REST API」から登録できます。

メモ：APIキーの作成は1回限りの手順です。作成したAPIキーは、インストール環境ごとに一意のものとなっています。

REST API利用の手順

  1. 管理タブをクリックします。
  2. ポータルとの連携で、REST APIをクリックします。
  3. APIキーが作成されます。例：7b5fde68148fa2419bc2f1a1ab87e757
  4. ブラウザーを開きURLを入力します。
    http://<myappmanager-server>:9090/AppManager/xml/ListServer?apikey=7b5fde68148fa2419bc2f1a1ab87e757&type=all
  5. 関連データの取得には、<type>を必要な監視に変えてください。次のURLが正しく機能するか確認をお願いします。
    http://<myappmanager-server>:9090/AppManager/xml/ListServer?apikey=7b5fde68148fa2419bc2f1a1ab87e757&type=server
    このURLでは、サーバー監視すべてのデータを取得できます。typeにserverではなくallを指定すると、Applications Managerが把握している監視すべてのデータを取得します。
  6. APIで必要な形式でHTTPリクエストを行うには、スクリプト言語、Java、C、Perl、PythonなどによるXMLパーサーをご利用ください。APIで取得したデータは、お客さまデータベースに投入したり、必要フォーマットに変換したりできます。

REST APIキーの再作成

APIキーを確認するには、Applications Managerでユーザーの写真をクリックしてください。ユーザーが管理者であれば、APIキーが、REST APIの管理タブに表示されます。

管理者は、自分のAPIキーも、他ユーザーのAPIキーも再作成する権限があります。

REST APIキーの再作成は、即座に終わります。Webポータルが継続して機能するよう、再生成後はただちに新しいAPIキーを利用する準備をしておいてください。