サービスAPI (クラシック)
概要
サービスAPI を使用すると、Nexthinkで監視しているITサービスの状態に関する情報をプログラムで取得できます。
サービスAPIのクライアントは、メインのアプライアンス（ポータル）の証明書を信頼する必要があります。
クライアントを認証するために、サービスAPIは基本認証を使用します。 Nexthinkは、APIのクライアントを専用に認証するためにローカルアカウントの作成を推奨しています。
サービスAPIの有効化
サービスAPIは完全にテストされており、実運用環境で使用できます。 ただし、現在も技術プレビュー段階にあり、使用する前に機能を有効にする必要があります。
サービスAPIを有効にするには：
ポータルアプライアンスのCLIにログインします。
任意：ポータルにまだ構成ファイルがない場合、つまり
/var/nexthink/portal/confフォルダにportal.confが存在しない場合は、サンプル構成ファイルからデフォルトをコピーして作成します：sudo -u nxportal cp /var/nexthink/portal/conf/portal.conf.sample \`n/var/nexthink/portal/conf/portal.conf\ポータルの構成ファイルを編集します：
sudo vi /var/nexthink/portal/conf/portal.conf以下の行を追加します：
globalconfig.feature.service-test-api = true変更を保存して終了します：
:wq設定を適用するためにポータルを再起動します：
sudo systemctl restart nxportal
利用可能なサービスデータの確認
サービスAPIを通じて利用可能なサービスデータをインタラクティブに探すには：
ウェブブラウザで次のアドレスに移動します：
<Portal_DNS_FQDN>をポータルの実際の名前に置き換えます。
サービスAPIのディスカバリーツールにログインします：
ウェブブラウザから資格情報を求められたら、ユーザー情報を入力します。
ディスカバリーツールは、階層内のユーザーのビュー領域に限られたサービスデータを表示します。
APIの問い合わせ方法
サービスAPIにクエリを投げるには、次のパラメータを使ったGETリクエストをAPI URLに送信します：
サービス（リクエストでは メトリックと命名されています）
目的のサービスのUID
（なし）
スコープ
時間（最後の60分間）
日（最後の24時間）
時間
階層
階層の名前
ポータル内の最初の階層の名前
階層レベル
階層内のレベルの名前
（なし）
パス
出力を制限するための階層内のノードの名前。 階層レベルをさらに下げた出力制限のためにいくつかのパス要素をチェーンします。
ユーザーのビュー領域内の最上位ノード
フォーマット
出力フォーマット、次のいずれか：
テーブル（HTMLテーブル形式）
json
csv
テーブル
サービスAPIのクエリでは、階層レベル または パス のパラメータを含めてください。ただし、両方同時には使用しないでください。
クエリURLの例：
サービスAPIは基本認証を使用します。 NexthinkアプライアンスからAPIをテストするには、curl を使用します。例：
サービスAPIの出力
サービスAPIから取得できるデータは、対応するポータルのダッシュボードからサービスの状態を分析するときに取得できるものと似ています。
以下にサービスAPIの出力の完全なリストを示します。
サービスの名前
選択したサービスの名前
階層レベルとノードの名前
階層レベル クエリの場合、応答は指定されたレベルの全ノードに集約結果を含め、親レベル（階層のトップにある場合はグローバルレベル）の各ノードにすべてという名前の集計結果を含めます。
パス クエリの場合、応答は指定されたノードのサービスデータを（すべてというエントリーにグループ化して）含み、その直下に子ノードを含めます。ただし、階層のベースレベルにあるエンティティレベルのノードには子ノードはありません。
サービスメトリック
サービスメトリックは、接続ベースのサービスかウェブベースのサービスかに依存し、サービスダッシュボードで見つけることができるものと同じです。
関連タスク
関連コンセプト
Last updated
Was this helpful?