VMware Aria Automation API プログラミングガイド

VMware Aria®Automation™ のユーザーまたはお客様は、REST API サービスコールを使用して、

VMware Aria Automation Assembler

、

VMware Aria Automation Service Broker

、および

VMware Aria Automation Pipelines

機能をプログラムで実行できます。

API サービス

VMware Aria Automation

には次の API が含まれています。製品で API ドキュメントを利用できます。1 つのランディングページからすべての Swagger 仕様にアクセスするには、

https://<your_FQDN>/automation/api-docs

に移動します。your_FQDN は

VMware Aria Automation

アプライアンスの FQDN です。

VMware Aria Automation
メインサービス	サービスの名前と説明
ABX	ABX アクションとそのバージョンを作成または管理します。アクションとフローを実行します。
Automation Service Broker	承認申請をプロビジョニングする前に展開または Day 2 アクションに必要となる同意を制御するポリシーの適用。
Automation Assembler	ブループリントブループリントを作成、検証、およびプロビジョニングします。 API のブループリントは製品の Automation Assembler テンプレートです。
Automation Service Broker	カタログ Automation Service Broker カタログアイテムおよびカタログソースにアクセスして、コンテンツの共有やカタログアイテムの申請などを実行します。
CMX	CMX VMware Aria Automation で Kubernetes を使用する場合に、Kubernetes クラスタと名前空間を展開し、管理します。
Automation Assembler	Content Gateway インフラストラクチャに、ソースコード管理プロバイダなどの外部コンテンツソースのコードコンテンツとして接続します。
Automation Service Broker および Automation Assembler	カスタムフォーム Automation Service Broker および Automation Assembler の動的なフォームのレンダリングとカスタマイズ動作を定義します。
ユーザープロファイル	カスタマイズブランディング情報を構成します。
Automation Service Broker	展開システムに展開されている展開オブジェクトとプラットフォーム、またはブループリントにアクセスします。 API のブループリントは製品の Automation Assembler テンプレートです。
Automation Service Broker	展開メトリック展開オブジェクトの集計メトリック値。
ID	ID VMware Aria Automation ユーザーの認証および認証の管理を行います。
Automation Assembler	Infrastructure as a Service (IaaS) リソースの検証とプロビジョニングを含むインフラストラクチャのセットアップタスクを繰り返し実行します。
移行	移行アシスタント評価を実行して移行サービスにアクセスします。vRealize Automation 7.6 コンテンツの移行および NSX-V から NSX-T への移行をサポートします。
再配置	オンボーディング管理下の任意のクラウドから既存の仮想マシンを移動する際のポリシーとプランを定義します。
Automation Orchestrator Client	Orchestrator 複雑な IT タスクを自動化するためのワークフロー、アクション、ポリシーを設計、管理、実行します。
Automation Orchestrator Client	Orchestrator Gateway ワークフローとアクションを実行して、複雑な IT タスクを自動化します。
Automation Pipelines	パイプラインアプリケーションを継続的に本番環境に提供するためのパイプラインを作成して実行します。
Automation Service Broker	ポリシー Automation Service Broker で作成されたポリシーを操作します。
プロジェクト	プロジェクトプロジェクトロールを持つユーザーにプロビジョニングされたリソースの可視性と分離を提供します。プラットフォームおよび RBAC サービスの Swagger ドキュメントは、プロジェクトサービスに付属しています。

VMware

は、パブリック API に対して互換性を破る変更が行われる場合、12 か月のサポート終了通知をユーザーに提供します。互換性を破る変更は、

VMware Aria Automation

のドキュメントに含まれるリリースノートに記載されています。

API のバージョン管理

API のバージョン管理を使用することを強く推奨しますが、必須ではありません。API バージョン管理を使用すると、API を特定の値にロックして、新しい API バージョンにアップグレードするタイミングを制御できます。API バージョン管理を使用しない場合、API に応じてデフォルトの動作が変わります。

IaaS API の場合、最新バージョンは

2021-07-15

です。バージョン管理なしで IaaS API を使用する場合、または

2021-07-15

以外の値を割り当てる場合、要求ではバージョン 2019-01-15 が使用されます。

ベストプラクティスとして、

2021-07-15

に割り当てられた apiVersion クエリパラメータを使用して IaaS API 要求をロックします。これにより、バージョン 2019-01-15 の提供が終了する前に最新バージョンにスムーズに移行できるようになります。Using Automation Assembler APIs to Build your Resource Infrastructureを参照してください。

その他の API の場合、apiVersion クエリパラメータに任意の日付を指定できます。値を指定しない場合、要求ではデフォルトで最新の API バージョンが使用されます。ただし、後方互換性は保持されず、API が変更されると、API 応答に予期しない変更が発生する可能性があります。

ベストプラクティスとして、API 要求で apiVersion クエリパラメータを使用し、API を Swagger 仕様に記載されている最新バージョンにロックします。新しい API バージョンが発表された場合は、 apiVersion クエリパラメータを新しいバージョンの値に変更して、そのバージョンにオプトインするタイミングを制御します。

次の例は、カタログ API で apiVersion クエリパラメータを使用する方法を示しています。カタログ API のバージョンは、2020-08-25、2020-01-30、および 2019-01-15 です。追加の apiVersion クエリパラメータを含めると、2020 年 1 月 30 日から 2020 年 8 月 24 日まで有効だった API バージョンへの呼び出しがロックされます。

GET https://appliance.domain.com/catalog/api/sources?apiVersion=2020-01-30

バージョン 2020-08-25 でリリースされた機能にオプトインする準備ができたら、apiVersion クエリパラメータの値を変更します。

GET https://appliance.domain.com/catalog/api/sources?apiVersion=2020-08-25

apiVersion クエリパラメータを最新バージョンに設定すると、2020-08-25 以降に発生するカタログ API の更新も確実に取得されます。ただし、新しいバージョンが発表されるまで互換性を破る変更は行われません。これらの変更は、apiVersion クエリパラメータの値を新しいバージョン以降と同等の日付に変更した場合にのみ行われます。

API バージョンは、

VMware Aria Automation

がリリースされるたびに変更されることはなく、すべてのサービスで同じになることもありません。使用するサービスの API バージョンを確認するには、

https://<FQDN>/automation-ui/api-docs

に移動し、カードをクリックして Swagger 仕様を開きます。