Contrail Insights API の使用 |Contrail Insights |ジュニパーネットワークス

Contrail Insights API

Contrail Insights は、ユーザーが必要に応じて Contrail Insights プラットフォームで操作を実行するための一連の API を公開しています。これらのAPIは、Contrail InsightsによってSwagger UIページで公開されます。ユーザーは Contrail Insights ダッシュボードからこの UI にアクセスし、Contrail Insights API を表示およびアクセスできます。Contrail Insights ダッシュボードの右上にある [ 設定] > [API ドキュメント ] を選択して、Contrail Insights API 用の Swagger UI へのリンクを表示します。

API を使用するための前提条件

Contrail Insights API では、ヘッダーおよび X-Auth-Type X-Auth-Tokenによる認証が必要です。これら 2 つの値は、[Contrail Insights ダッシュボード] ページで確認できます。図1を参照してください。

Contrail Insights API の認証を設定するには、次の手順に従います。

Contrail Insights ダッシュボードをウェブブラウザで開きます。例えば：
図 1: Contrail-insights API に必要な認証ヘッダー:X-Auth-Type と X-Auth-Token
ダッシュボードページで [ AppFormix ドキュメントへのリンク ] を選択し、Contrail Insights プラットフォームのメイン API を表示します。

[ AppFormix 分析ドキュメントへのリンク] を選択して、分析 API を表示します。

Contrail Insights API の使用例

次の手順では、 /aggregatesSwaggerを使用したContrail Insights APIでのPOSTおよびGET呼び出しについて説明します。他の API でも同様のアクションを実行できます。

投稿/集計
GET /集計

投稿/集計

この REST 呼び出しにより、Contrail Insights に新しいアグリゲートが作成されます。Swagger UI の [POST /aggregates ] セクションをクリックして、この POST 呼び出しの必須フィールドを表示します。

新しい集計を作成するために必要な次の例のヘッダーと本文を使用します。

POST /aggregates API に関する上記の情報を入力し、[試してみる] をクリックします。この操作により、Contrail Insights に demo-host-aggregateという名前の新しいアグリゲートが作成されます。図2を参照してください。

メモ：
テキスト領域にすべての関連フィールドを入力するには、[ モデルスキーマ] をクリックし、その下のスニペットをクリックします。

図 2: POST /aggregates API 呼び出しによる新しいアグリゲートの作成

GET /集計

この REST 呼び出しにより、Contrail Insights プラットフォーム上に存在するすべてのアグリゲーションが一覧表示されます。上記の POST 呼び出しからの新しい集計が正常に作成されたかどうかを確認するには、Swagger UI で GET /aggregates API のヘッダーを指定し、[試してみる] をクリックします。出力には、新しいアグリゲートの詳細が表示されます。図3を参照してください。

図 3: GET /aggregates API 呼び出し Verify New Aggregate with GET /aggregates API Call

による新しいアグリゲートの検証

このページの目次

Contrail Insights API の使用