リストエンジンAPI（クラシック）

概要

エンジンリストAPI を使用すると、Portalにリンクされた全てのEngineの接続ステータスと詳細をプログラムで取得できます。

エンジンリストAPIのクライアントは、プライマリーアプライアンス（Portal）の証明書を信頼する必要があります。

クライアントを認証するために、エンジンリストAPIは基本認証を使用します。 Nexthinkは、APIのクライアントを専用に認証するためのローカルアカウントの作成を推奨します。

クライアントを認証するために、エンジンリストAPIは基本認証をサポートしています。 Nexthinkは、APIのクライアントを専用に認証するためのローカルアカウントの作成を推奨します。

Nexthinkを設定して、アクセスの委譲のためのオープンスタンダードであるOAuthを使用してエンジンリストAPIへのアクセスを許可することができます。 Nexthink サポートに問い合わせて、詳細情報を入手してください。

エンジンリストAPIにクエリを送るために、以下のパラメータなしのGETリクエストをPortalに送信してください:

https:///api/configuration/v1/engines

<Portal_DNS_FQDN>をPortalの実際の名前に置き換えてください。

エンジンリストAPIにクエリを送るために、以下のパラメータなしのGETリクエストをPortalに送信してください:

https://agora.<region>.nexthink.cloud/api/configuration/v1/engines

<region>は、導入時に組織に割り当てられたNexthink Experienceプラットフォームの地域と一致する必要があります。

エンリッチメントAPIは、現在以下の地域で利用可能です:

エンジンリストAPIから取得できるデータは、PortalをEngineに接続したときのEngineダッシュボードから得られるものと類似しています。

出力には、JSON形式でエンジンのリストが保持されています。各エンジンについて、次を見つけます:

出力データ

説明

名前

エンジンの名前

databaseUID

エンジンデータベースのUID

machineID

エンジンを動かしているマシンのID

説明

接続時に管理者がエンジンに与えた説明。

ステータス

Portalとエンジン間の接続ステータス:

アドレス

エンジンのIPアドレス

ポート

Portalの接続を待っているエンジンのTCPポート番号。

タイムゾーン

エンジンで設定されているタイムゾーン。

バージョン

エンジンのバージョン番号。

Last updated 29 days ago