ブラウザまたは HTTP クライアント プログラムを使用して、要求を送信し、応答を受け取ることができます。

REST クライアント プログラム

HTTPS 要求を送信できるクライアント アプリケーションは、VMware Aria Operations API を使用して REST アプリケーションを開発するための適切なツールです。REST クライアント プラグインは、ほとんどのブラウザおよび多くの IDE で使用できます。通常、次のオープンソース プログラムが使用されます。

  • cURL。http://curl.haxx.se
  • Postman アプリケーション。http://www.getpostman.com

さらに、VMware により、VMware Aria Operations API のための言語固有のクライアント バインドが提供されます。

スキーマ リファレンスについて

VMware Aria Operations REST API ドキュメントには、VMware Aria Operations API のすべての要素、タイプ、クエリ、および操作に関するリファレンス資料が含まれています。また、スキーマ定義ファイルも含まれています。

Swagger ベースの API ドキュメントは、ランディング ページから REST API 呼び出しの実行が可能な製品で入手可能です。

API のドキュメントにアクセスするには、 VMware Aria Operations クラウド プロキシの URL を使用します。たとえば、クラウド プロキシの URL が https://www.cloudproxy.vmware.com の場合、API リファレンスは https://cloudproxy.vmware.com/suite-api/doc/swagger-ui.html から入手できます。
注： API ドキュメントにアクセスするには、URL に、クラウド プロキシの IP アドレスまたは FDQN を使用する必要があります。

言語固有のクライアント バインドは、以下から入手できます。 

https://www.cloudproxy.vmware.com/vrops-cloud/suite-api/

VMware Aria Operations API の認証

API 呼び出しを実行するには、アクセス トークンを使用して Swagger ユーザー インターフェイスで VMware Aria Operations クラウド プロキシを認証する必要があります。[CSP トークン (apiKey)] の値を入力し、[認証] をクリックします。

VMware Aria Operations API の例について

すべての例に、HTTP 要求と応答が含まれます。これらの例は、監視対象環境内のオブジェクトに関する情報の作成とクエリなど、操作に関連するワークフローとコンテンツを示しています。

要求本文の例は JSON 形式です。VMware Aria Operations API に必要な要求ヘッダーは、要求の例に含まれています。これはより大きな例からの抜粋ではありません。

ほとんどの応答の例では、説明している操作に関わる要素と属性のみを示しています。省略記号 (...) は、応答内で内容が省略されていることを示します。