最新の API 情報は、 Cloud Insights にログインし、 * Admin > API アクセス * に移動することで確認できます。[API Documentation*] リンクをクリックします。

API ドキュメントは Swagger ベースです。 API の簡単な概要情報と使用方法を提供しており、環境内で試すことができます。ユーザーの役割や Cloud Insights エディションによっては、使用可能な API タイプが異なる場合があります。

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

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

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

トークンは、顧客の視点からAPIへの汎用アクセスを付与し、APIへのアクセスを自身のテナントのスコープで管理します。お客様の管理者は、 Cloud Insights のバックエンド担当者から直接関与することなく、これらのトークンを付与したり取り消したりできます。

アプリケーションは、ユーザがアクセスの認証と許可に成功した後、ターゲット API を呼び出すときにアクセストークンをクレデンシャルとして渡します。渡されたトークンは、 API にアクセスするためのトークンのベアラーが許可されていることを API に通知し、許可中に許可されたスコープによって指定された特定のアクションを実行します。

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

たとえば、次のようにしてストレージアセットを取得します。

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

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

これ以外のタイプや API は、時間の経過とともに使用できるようになる可能性があります。最新の API 情報は、で確認できます "API Swagger のドキュメント"。

ユーザがアクセスできる API タイプは、でも異なります "ユーザロール" 各Cloud Insights 機能セット（監視、ワークロードセキュリティ、レポート）に含まれています。

このセクションでは、 Cloud Insights オブジェクトの階層をトラバースする方法について説明します。

多くの API コマンドでは、関連オブジェクトのオブジェクトや URL に関する追加情報を提供する * expand * パラメータがサポートされています。

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

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

各展開には、データ、 URL 、またはその両方が含まれます。expand パラメータでは、次のような複数の属性とネストされた属性がサポートされます。

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

パフォーマンスデータは、さまざまなデバイスにわたって個別のサンプルとして収集されます。Cloud Insights は、 1 時間ごと（デフォルト）にパフォーマンスサンプルをまとめたものです。

この API を使用すると、サンプルと集計データの両方にアクセスできます。パフォーマンスデータが格納されたオブジェクトの場合、パフォーマンスの概要は expand = performion.パフォーマンス履歴の時系列は、 Nested_expand= perform中 .history_ で確認できます。

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

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

パフォーマンスサマリーには、 1 つのパフォーマンスカウンタから特定の期間（ 1 時間、 24 時間、 3 日間など）にわたって計算された概要、ユニット、サンプル開始時間、サンプル終了時間、および要約された値（現在、最小、最大、平均など）のコレクションが含まれます。

結果の Performance Data ディクショナリには、次のキーがあります。

パフォーマンスデータのオブジェクトタイプごとに、一意のパフォーマンス指標のセットがあります。たとえば、仮想マシンのパフォーマンスオブジェクトは、パフォーマンスメトリックとして「 diskThroughput 」をサポートします。サポートされている各パフォーマンスメトリックは、メトリックディクショナリに示されている特定の「パフォーマンスカテゴリ」です。Cloud Insights では、本ドキュメントで後述するパフォーマンス指標タイプを複数サポートしています。各パフォーマンスメトリックディクショナリには、このパフォーマンスメトリックの判読可能な概要である「概要」フィールドと、パフォーマンスサマリーカウンタエントリのセットも含まれます。

Performance Summary カウンタは、パフォーマンスカウンタの要約です。これは、カウンタの一般的な集計値であり、最新の測定値、要約データの時間範囲、カウンタの単位タイプ、データのしきい値なども表示します。しきい値のみオプションで、残りの属性は必須です。

パフォーマンス要約は、次のタイプのカウンタで使用できます。

API は、環境内のオブジェクトについて、次のような詳細な指標を返すことができます。

を参照してください "API Swagger のドキュメント" 各オブジェクトタイプの指標に関する情報が表示されます。

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

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

ディスクのパフォーマンスデータの JSON の例を次に示します。

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

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

Cloud Insights は拡張可能な（オープンな）解決策で、サードパーティのオーケストレーションシステム、ビジネス管理システム、変更管理システム、チケット処理システムとの統合や、カスタム CMDB の統合を可能にします。

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

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

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

API アクセストークンには有効期限があります。API アクセストークンの期限が切れると、ユーザは新しいトークン（ TYPE_Data Ingestion _ with Read/Write パーミッション）を生成し、期限切れのトークンではなく、新しく生成されたトークンを使用するように Telegraf を再設定する必要があります。以下の手順では、その方法について詳しく説明します。