最新の API 情報は、Data Infrastructure Insightsにログインし、管理 > API アクセス に移動すると見つかります。 API ドキュメント リンクをクリックします。

API ドキュメントは Swagger ベースであり、API の簡単な説明と使用方法の情報を提供し、テナントで試用することができます。ユーザー ロールやData Infrastructure Insightsエディションに応じて、使用できる API タイプが異なる場合があります。

Data Infrastructure Insights API を使用する前に、1 つ以上の API アクセス トークン を作成する必要があります。アクセス トークンは指定された API タイプに使用され、読み取り権限や書き込み権限を付与できます。各アクセス トークンの有効期限を設定することもできます。指定されたタイプのすべての API はアクセス トークンに対して有効です。各トークンにはユーザー名やパスワードはありません。

アクセス トークンを作成するには:

トークンを無効化、有効化、取り消しできます。無効になっているトークンを有効にすることができます。

トークンは、顧客の観点から API への汎用アクセスを許可し、独自のテナントの範囲内で API へのアクセスを管理します。顧客管理者は、Data Infrastructure Insightsのバックエンド担当者が直接関与することなく、これらのトークンを付与したり取り消したりできます。

アプリケーションは、ユーザーが正常に認証してアクセスを承認するとアクセス トークンを受け取り、ターゲット API を呼び出すときにアクセス トークンを資格情報として渡します。渡されたトークンは、トークンの所有者が API にアクセスし、承認時に付与されたスコープによって指定された特定のアクションを実行することを承認されたことを API に通知します。

アクセス トークンが渡される HTTP ヘッダーは X-CloudInsights-ApiKey: です。

たとえば、ストレージ アセットを取得するには、次を使用します。

使用したい API に固有の例については、Swagger ページを参照してください。

Data Infrastructure Insights API はカテゴリベースで、現在次のタイプが含まれています。

今後、追加のタイプや API が利用可能になる可能性があります。最新のAPI情報は、"API Swaggerドキュメント" 。

ユーザーがアクセスできるAPIの種類は、"ユーザ ロール"各Data Infrastructure Insights機能セット (監視、ワークロード セキュリティ、レポート) に備わっています。

このセクションでは、Data Infrastructure Insightsオブジェクトの階層を移動する方法について説明します。

多くの API コマンドは、オブジェクトに関する追加の詳細または関連オブジェクトの URL を提供する expand パラメータをサポートしています。

共通する展開パラメータは expands です。応答には、オブジェクトに使用可能なすべての特定の展開のリストが含まれます。

たとえば、次のように要求するとします。

各展開には、データ、URL、またはその両方が含まれます。 expand パラメータは、複数のネストされた属性をサポートします。例:

これを防ぐために、最上位レベルのコレクションのリクエストは拡張できません。たとえば、すべてのストレージ オブジェクトのデータ拡張を一度に要求することはできません。クライアントはオブジェクトのリストを取得し、展開する特定のオブジェクトを選択する必要があります。

パフォーマンス データは、多数のデバイスにわたって個別のサンプルとして収集されます。 Data Infrastructure Insights は、1 時間ごとに (デフォルト) パフォーマンス サンプルを集計して要約します。

API を使用すると、サンプルと要約データの両方にアクセスできます。パフォーマンス データを持つオブジェクトの場合、パフォーマンスの概要は expand=performance として利用できます。パフォーマンス履歴の時系列は、ネストされた expand=performance.history を通じて利用できます。

パフォーマンス データ オブジェクトの例には次のようなものがあります。

パフォーマンス メトリックには説明とタイプがあり、パフォーマンス サマリーのコレクションが含まれています。たとえば、レイテンシ、トラフィック、レートなどです。

パフォーマンス サマリーには、説明、単位、サンプルの開始時刻、サンプルの終了時刻、および時間範囲 (1 時間、24 時間、3 日間など) にわたって単一のパフォーマンス カウンターから計算された集計値 (現在値、最小値、最大値、平均値など) のコレクションが含まれます。

結果として得られるパフォーマンス データ ディクショナリには、次のキーが含まれます。

各パフォーマンス データ オブジェクト タイプには、固有のパフォーマンス メトリックのセットがあります。たとえば、仮想マシン パフォーマンス オブジェクトは、パフォーマンス メトリックとして「diskThroughput」をサポートします。サポートされている各パフォーマンス メトリックは、メトリック ディクショナリに提示される特定の「performanceCategory」に属します。 Data Infrastructure Insights は、このドキュメントの後半にリストされているいくつかのパフォーマンス メトリック タイプをサポートしています。各パフォーマンス メトリック ディクショナリには、このパフォーマンス メトリックの人間が判読できる説明である「説明」フィールドと、パフォーマンス サマリー カウンター エントリのセットも含まれます。

パフォーマンス サマリー カウンターは、パフォーマンス カウンターを要約したものです。カウンターの最小値、最大値、平均値などの一般的な集計値と、最新の観測値、要約データの時間範囲、カウンターの単位タイプ、データのしきい値が表示されます。しきい値のみがオプションであり、残りの属性は必須です。

パフォーマンス サマリーは、次の種類のカウンターで利用できます。

API は、テナント上のオブジェクトの詳細なメトリックを返すことができます。次に例を示します。

参照"API Swaggerドキュメント"各オブジェクト タイプのメトリックに関する情報。

履歴データは、タイムスタンプとカウンター マップのペアのリストとしてパフォーマンス データ内に表示されます。

履歴カウンターは、パフォーマンス メトリック オブジェクト名に基づいて名前が付けられます。たとえば、仮想マシンのパフォーマンス オブジェクトは「diskThroughput」をサポートしているため、履歴マップには「diskThroughput.read」、「diskThroughput.write」、「diskThroughput.total」という名前のキーが含まれます。

以下は、ディスクのパフォーマンス データ JSON の例です。

容量属性を持つオブジェクトは、基本データ型と CapacityItem を使用して表現します。

検索 API はシステムへのシンプルなエントリ ポイントです。 API への唯一の入力パラメータは自由形式の文字列であり、結果の JSON には分類された結果リストが含まれます。タイプは、ストレージ、ホスト、データストアなど、インベントリとは異なる資産タイプです。各タイプには、検索条件に一致するタイプのオブジェクトのリストが含まれます。

Data Infrastructure Insights は、サードパーティのオーケストレーション、ビジネス管理、変更管理、チケット発行システム、およびカスタム CMDB 統合との統合を可能にする拡張可能な (オープンな) ソリューションです。

Cloud Insight の RESTful API は、データのシンプルかつ効率的な移動を可能にするとともに、ユーザーがデータにシームレスにアクセスできるようにする主要な統合ポイントです。

API トークンを一時的に無効にするには、API トークン リスト ページで、API の「3 つのドット」メニューをクリックし、「無効」を選択します。同じメニューを使用して [有効にする] を選択すると、いつでもトークンを再度有効にすることができます。

API トークンを完全に削除するには、メニューから「取り消し」を選択します。取り消されたトークンを再度有効にすることはできません。新しいトークンを作成する必要があります。

API アクセス トークンには有効期限があります。 API アクセス トークンの有効期限が切れると、ユーザーは新しいトークン (読み取り/書き込み権限を持つ データ インジェスチョン タイプ) を生成し、期限切れのトークンの代わりに新しく生成されたトークンを使用するように Telegraf を再構成する必要があります。その方法については、以下の手順で詳しく説明します。