VMware Edge Network Intelligence システムには、プログラム可能なインターフェイスを介して大量のデータにアクセスできるようにする、読み取り専用の強力な API があります。この連携により、組織は VMware Edge Network Intelligence データを、データ ウェアハウスやビジネス インテリジェンス ソリューションなどの外部システムに統合できます。

VMware Edge Network Intelligence API は、Graph QL に基づく読み取り専用 API です。GraphQL に精通していない場合は、GraphQL guideにアクセスして、フレームワークの詳細を確認することをお勧めします。Graph QL が他の API インターフェイスと比較して優れている点の 1 つは、REST とは異なり、フィルタリングされたデータを 1 回の呼び出しで取得できることです。

現在サポートされているデータ要素

クライアント

属性、履歴、パフォーマンス

アプリケーション

使用量、スループット

Access Point

属性、パフォーマンス

カスタム グループ

パフォーマンス

推奨事項

詳細

グローバル アドバイザリ

詳細

IoT のセキュリティ

単一デバイス/グループの動作分析

インシデント

詳細

API のインタラクティブ調査

VMware Edge Network Intelligence では、対話形式のグラフィカル インターフェイスを使用して API を確認できます。API の GUI にアクセスするには、VMware Edge Network Intelligence アプリケーションに対して認証されている必要があります。その後、https://<your-ENI-URL>/api/v2/graphiql に移動できます。

API レート制限

パブリック クラウド上の VMware Edge Network Intelligence API サーバは、1 秒あたり 2 個のリクエストを処理できます。一度に最大で 60 個のリクエストを送信してキューに入れることができ、1 秒あたり 2 個のリクエスト レートで処理されます。60 個を超えるリクエストが同時に受信された場合、最初の 60 個の後のリクエストは 429 エラー コード「API リクエストの制限に達しました (You have hit the API request limit)」で返されます。プライベート クラウド アプライアンス上の API リクエストは、レートが制限されていません。

API トークンの生成

API トークンを生成するには、ユーザーの環境設定に移動して、開発者 API を選択します。

そこから、API に対する認証に使用できるトークンを生成できます。
図 1. API トークンの生成

GitHub ドキュメント

API の詳細については、GitHub リポジトリを参照してください

API の例

特定の場所で過去 2 週間に 2.4 GHz で接続している 5 GHz 対応クライアントのリスト

サンプル クエリ

query{
 deviceList(filters:{
    op:AND,
     filters:[
      {field:"rfBand", value:"2"},
        {field:"is5ghzCapable", value:"true"}
     ]
}){
totalCount
devices {
hostname
macAddr
is5ghzCapable
rfBand
userName
isIotDevice
apDwellTimeMs
createdAt
deviceTypeDetails {
model
osAndVersion
deviceClass
}
}
}
}
図 2. サンプル応答