エンジンリストAPI (クラシック)

概要

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

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

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

認証

ユーザーアカウント

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

OAuth

OAuthというアクセス委任のためのオープン標準を使用して、エンジンリストAPIへのアクセスを許可するようNexthinkを構成できます。 Nexthink サポートに問い合わせて、詳細情報を入手してください。

APIのクエリ

ユーザーアカウント

エンジンリストAPIにクエリを送信するには、以下のGETリクエストをパラメーターなしでポータルに送信します：

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

<Portal_DNS_FQDN> をポータルの実際の名前に置換します。

OAuth

エンジンリストAPIにクエリを送信するには、以下のGETリクエストをパラメーターなしでポータルに送信します：

https://agora.<region>.nexthink.cloud/api/configuration/v1/enginesを参照してください`

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

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

• ヨーロッパ

• メタ地域

• 太平洋地区

• アメリカ地区

エンジンリストAPIの出力

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

出力はJSON形式でエンジンのリストを保持しています。 各エンジンに対しては以下が含まれます：

出力データ	説明
名前	エンジンの名前
databaseUID	エンジンデータベースのUID
machineID	エンジンを実行するマシンのID
説明	管理者が接続時にエンジンに与えた説明
ステータス	ポータルとエンジン間の接続ステータス： 接続済み 未接続 接続中
アドレス	エンジンのIPアドレス
ポート	ポータルの接続を受け付けるエンジンがリッスンするTCPポート番号。
タイムゾーン	エンジンに設定されているタイムゾーン。
バージョン	エンジンのバージョン番号。