API プログラミング

VMware Aria®Suite Lifecycle のユーザーまたはお客様は、REST API サービス コールを使用して、
VMware Aria Suite Lifecycle
機能をプログラムで実行できます。API は REST スタイルに従い、ライセンス供与されたすべてのユーザーが使用できるようになります。

API リファレンスについて

API は、
VMware Aria Suite Lifecycle
を使用してインストールします。Swagger ドキュメントは、次の URL から入手できます。
  • VMware Aria Suite Lifecycle
    API の場合は、
    https://
    $url
    /api/swagger-ui.html
    に移動します。
  • コンテンツ管理 API の場合は、
    https://
    $url
    /lcm/cms/api/swagger-ui.html
    に移動します。
$url
は、
VMware Aria Suite Lifecycle
のインスタンスのベース URL を示します。
VMware Aria Suite Lifecycle
Swagger ドキュメントは、VMware Developer サイトから一般公開されています。VMware Aria Suite Lifecycle REST APIを参照してください。
VMware
は、パブリック API に対して互換性を破る変更が行われる場合、12 か月のサポート終了通知をユーザーに提供します。API の変更を確認するには、
VMware Aria Suite Lifecycle
ドキュメント
に含まれているリリース ノートを参照してください。

開発者の API 使用方法

API サービス呼び出しを実行するには、ブラウザ アプリケーションまたは HTTP クライアント アプリケーションを使用して要求を送信し、応答を確認します。通常、次のオープンソース アプリケーションが使用されます。
API の使用方法を学習するには、次の使用事例に記載されている手順を実行して開始できます。
すべての使用事例には、要求の例に
curl
コマンドが含まれています。コマンドを使用するには、
jq
コマンドラインの JSON プロセッサを
curl
でインストールします。
jq
パーサーにより、読みやすさが最適になるように、応答の書式が設定されます。
jq
インストールの詳細については、https://stedolan.github.io/jq/ を参照してください。
VMware Aria Suite Lifecycle
の Postman コレクションは、
ドキュメント
タブでサンプルとして提供されます。

認証

VMware Aria Suite Lifecycle
の API には、ローカル ユーザー(user@local など)としてアクセスします。ローカル認証では、基本的な認証要求ヘッダーが使用されます。
curl -H "Authorization: Basic <
token
>" -k https://<
LCM_hostname
>/lcm/lcops/api/settings/systemsettings
Where:
  • LCM_hostname
    は、
    VMware Workspace ONE Access
    クラスタを管理する
    VMware Aria Suite Lifecycle
    サーバのホスト名または IP アドレスです。
  • token
    は、Base64 でエンコードされた「username:password」の値で、ユーザー名 admin@local と、admin@local のパスワードを使用します。Base64 形式にエンコードするには、 https://www.base64encode.org/ などの Web アプリケーションを使用します。
次の要求例は、
admin@local:ThisIsPassword
のエンコードされた値であるトークンを使用して呼び出しを行う方法を示しています。
curl -H "Authorization: Basic YWRtaW5AbG9jYWw6VGhpc0lzUGFzc3dvcmQ=" -k https://vrlcm.vrack.local/lcm/lcops/api/settings/systemsettings