5.1 API一覧
JP1/IMのユーザー作成プラグインで使用できるAPIの一覧を次の表に示します。
|
分類 |
API名 |
機能 |
|---|---|---|
|
ユーザー認証 |
インテリジェント統合管理基盤にログインします。 |
|
|
インテリジェント統合管理基盤にログアウトします。 |
||
|
初期シークレットを発行します。 |
||
|
データベースに登録済みのIMクライアントシークレットを削除します。 |
||
|
IMクライアントシークレットを発行してデータベースに登録します。 |
||
|
登録済みのIMクライアントIDの一覧を取得します。 |
||
|
リンク情報 |
オブジェクトの順序関係を表すリンク情報を取得します。 |
|
|
リンク情報の種別の一覧を取得します。 |
||
|
イベント管理 |
指定した条件に従って統合監視DBからイベントを検索します。 |
|
|
指定したイベントの詳細情報を取得します。 |
||
|
指定したイベントの対処状況を変更します。 |
||
|
指定されたイベントを発行します。 |
||
|
外部システムから通知されたイベント情報をJP1イベントに変換して発行します。 |
||
|
性能情報 |
性能情報のプラグイン処理を実行します。 |
|
|
システムのステータス監視 |
システム構成情報を取得し，構成管理ツリーファイルを生成します。 |
|
|
構成管理ツリーファイルをインテリジェント統合管理基盤に反映します。 |
||
|
JP1/AJS3，JP1/PFM，JP1/IM，JP1/Baseなどから取得したIM管理ノード情報を取得します。 |
||
|
IM管理ノード（管理グループまたは管理オブジェクト）の構成情報をツリー形式で取得します。 |
||
|
IM管理ノード（管理グループまたは管理オブジェクト）のステータス情報をすべて取得します。 |
||
|
IM管理ノードと提案IDのマッピング情報を取得します。 |
||
|
プロキシ |
プロキシサーバの認証ユーザーとパスワードを設定します。 |
|
|
連携製品 |
IM管理ノードに設定された連携製品起動URLを取得します。 |
|
|
トレンド |
指定されたSIDのメトリック一覧を取得します。 |
|
|
指定されたSIDの時系列データを取得します。 |
||
|
トレンドデータをトレンドデータ管理DBに書き込みます。書き込むデータはJSON形式で指定できます。 |
||
|
情報管理 |
JP1/IMのバージョンおよびREST APIのバージョンを取得します。 |
|
|
提案 |
対処アクションの前回実行履歴を取得します。 |
|
|
システム状況に応じた対処アクションを提案します。 |
||
|
対処アクションを実行します。 |
||
|
OpenID認証 |
シングルサインオンマッピング定義ファイル（imdd_sso_mapping.properties）で定義したマッピング情報を，インテリジェント統合管理基盤に反映します。 |
|
|
配布 |
リクエスト行で指定した配布物（ファイル）をダウンロードします。 |
|
|
自動/手動対処アクションの実行 |
対処アクションの実行結果を取得します。 |
|
|
対処アクションの手動実行を行います。 |
||
|
イベント情報の引き継ぎを行います。 |
||
|
定義ファイル操作 |
定義ファイルの一覧を取得します。 |
|
|
定義ファイルを取得します。 |
||
|
定義ファイルを削除します。 |
||
|
定義ファイルを更新します。 |
||
|
統合エージェント管理 |
統合エージェント情報を取得します。 |
|
|
統合エージェント情報を削除します。 |
||
|
統合エージェント制御基盤で管理するシークレットの一覧を取得します。 |
||
|
統合エージェント制御基盤で管理するシークレットを追加，更新，削除します。 |
||
|
下位マネージャー情報管理 |
統合マネージャー配下の拠点/中継マネージャーの情報を取得します。 |
|
|
統合マネージャー配下の拠点/中継マネージャーの情報を登録します。 |
||
|
統合マネージャー配下の拠点/中継マネージャーの情報を削除します。 |
|
分類 |
API名※ |
機能 |
|---|---|---|
|
Prometheus server |
Prometheus serverの定義ファイルを再読み込みし，Prometheus serverの動作に反映します。 |
|
|
Prometheus serverのヘルスチェックを行います。 ステータスコードは常に200を返却します。 |
||
|
Alertmanager |
Alertmanagerの定義ファイルを再読み込みし，Alertmanagerの動作に反映します。 |
|
|
Alertmanagerのヘルスチェックを行います。 ステータスコードは常に200を返却します。 |
||
|
Alertmanagerに作成されているサイレンスの一覧をJSON形式で取得します。 |
||
|
JSON形式のサイレンスの設定を引数で渡し，Alertmanagerにサイレンスを作成します。 |
||
|
Alertmanagerに作成されているサイレンスを失効（即時期限切れ）させます。 |
||
|
指定したサイレンスをJSON形式で取得します。 |
||
|
Blackbox exporter |
Blackbox exporterの定義ファイルを再読み込みし，Blackbox exporterの動作に反映します。 |
|
|
JP1/IM - Agentが使用するExporterのスクレイプ用のAPI |
Prometheus serverのスクレイプ対象の各Exporterのスクレイプを実行します。 |
|
- 注※
-
各APIにアクセス制御機能はありません。ファイアウォールで許可するポートに対して，接続可能なIPアドレスを指定することにより，APIの接続元ホストを制限できます。