ブラウザまたは 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 のための言語固有のクライアント バインドが提供されます。「スキーマ リファレンスのための Swagger ドキュメントへのアクセス」を参照してください。

スキーマ リファレンスのための Swagger ドキュメントへのアクセス

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

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

API ドキュメントにアクセスするには、まず VMware Aria Operations インスタンスの URL で VMware Aria Operations にログインする必要があります。

たとえば、インスタンスの URL が https://www.mgmt.cloud.vmware.com の場合、API リファレンスは https://www.mgmt.cloud.vmware.com/vrops-cloud/suite-api/doc/swagger-ui.html から入手できます。
注: 組織が米国外に拠点を置いている場合は、API エンドポイントには国の略語を使用します。不適切なエンドポイントを使用すると、404 エラーが発生します。たとえば、組織がオーストラリアにある場合、国の略語は AU で、API ドキュメントは次で入手可能となります。
https://au.www.mgmt.cloud.vmware.com/vrops-cloud/suite-api/doc/swagger-ui.html

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

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

VMware Aria Operations API の例について

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

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

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