サービスAPI（クラシック）

概要

サービス API は、Nexthinkを使用して監視しているITサービスの健康状態に関するデータをプログラムで取得できるようにします。

サービス API のクライアントは、メインアプライアンス（Portal）の証明書を信頼しなければなりません。

クライアントを認証するために、サービス APIはBasic Authenticationを使用します。 Nexthinkは、APIのクライアントを専用に認証するためのローカルアカウントを作成することを推奨します。

サービス API を有効にする

サービス API は完全にテストされており、実運用環境で使用できます。しかし、まだ技術プレビューの段階にあり、使用する前に機能を有効化する必要があります。

サービス API を有効にするには：

Portal ApplianceのCLIにログインします。
オプション: Portal にまだ設定ファイルがない場合、つまり/var/nexthink/portal/conf フォルダに portal.conf が存在しない場合、サンプル設定ファイルからデフォルトをコピーして作成します: sudo -u nxportal cp /var/nexthink/portal/conf/portal.conf.sample \ /var/nexthink/portal/conf/portal.conf
Portal 設定ファイルを編集します: sudo vi /var/nexthink/portal/conf/portal.conf
次の行を追加します: globalconfig.feature.service-test-api = true
変更を保存して終了します: :wq
設定を適用するために Portalを再起動します: sudo systemctl restart nxportal

利用可能なサービスデータを見つける

サービス API を介して利用可能なサービスデータをインタラクティブに探すには：

次のアドレスに web ブラウザでナビゲートします：
```
https://<Portal_DNS_FQDN>/api/beta/services
```
- <Portal_DNS_FQDN> を Portal の実際の名前に置き換えます。
サービス API のディスカバリーツールにログインします：
- webブラウザから要求されたときにユーザーの資格情報を入力します。
- ディスカバリーツールは、階層内のユーザーの表示ドメインに限定されたサービスデータを表示します。

API のクエリ

サービス API をクエリするには、次のパラメータで API URL に GET リクエストを送信します：

パラメータ

説明

デフォルト値

service（リクエスト内でmetricと命名）

希望するサービスのUID

(なし)

scope

hour（直近60分）
day（直近24時間）

hour

hierarchy

階層の名前

Portal内の最初の階層の名前

hierarchy-level

階層内のレベルの名前

(なし)

path

出力を制限するための階層内のノードの名前。階層レベル内で出力をさらに下に制限するために複数のパス要素を連鎖します。

ユーザーの表示ドメインの最上位ノード

format

出力形式、以下のいずれか：

table（HTMLテーブル）
json
csv

table

サービス API のクエリに hierarchy-level または path パラメータを含めますが、同時には含めません。

クエリ URL の例：

https://<Portal_DNS_FQDN>/api/beta/service/data/overview?
metric=57dc824c-3507-434a-9658-2d98255c1eff&
hierarchy=Location&
path=Europe&path=Switzerland&
format=table

サービス API は Basic Authentication を使用します。 NexthinkアプライアンスからAPIをテストするには、例えばcurlを使用できます：

curl https://<Portal_DNS_FQDN>/api/beta/service/data/overview?... -u username:password

サービス API の出力

サービス API から取得できるデータは、Portal内のサービスの健康状態を分析する際に得られるものと同様です。

以下にサービス API の出力の完全な一覧を示します：

出力データ

説明

サービスの名前

選択されたサービスの名前

階層レベルとノードの名前

階層レベル クエリの場合、応答は、指定されたレベルで各ノードのサービスデータを分解し、親レベルの各ノードの集計結果<強調>all<強調終了>を含めます（階層のトップで定義されたレベルの場合のグローバルレベル）。
パスクエリの場合、応答は指定されたノード（全ての名前でまとめられている）およびその直下の子ノードのサービスデータを含むが、エンティティレベルのノードを除きます。これは階層の基本レベルで子ノードがありません。

サービスメトリクス

サービスメトリクスは、接続ベースまたはwebベースのサービスであるかによって異なり、サービスダッシュボードで見つけられるものと同じです。