API 程式設計
Last Updated January 26, 2025

身為 VMware Aria®Suite Lifecycle 的使用者或客戶,您可以使用 REST API 服務呼叫,以程式設計方式執行
VMware Aria Suite Lifecycle
功能。API 遵循 REST 樣式,並可供所有授權使用者使用。

關於 API 參考

API 隨
VMware Aria Suite Lifecycle
一起安裝。可從以下 URL 取得 Swagger 文件。
  • 若要取得
    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 Developer 網站取得公開的
VMware Aria Suite Lifecycle
Swagger 文件 。請參閱。
VMware
針對公用 API 的任何中斷變更,為客戶提供 12 個月的生命週期終止通知。若要檢閱 API 變更,請參閱
VMware Aria Suite Lifecycle
說明文件
隨附的版本說明。

開發人員如何使用 API

若要進行 API 服務呼叫,您可以使用瀏覽器應用程式或 HTTP 用戶端應用程式來傳送要求並檢閱回應。通常會使用下列開放原始碼應用程式:
若要瞭解如何使用 API,您可以從執行下列使用案例中概述的步驟開始:
所有使用案例均在要求範例中包含
curl
命令。若要使用命令,請確保已透過
curl
安裝了
jq
命令列 JSON 處理器。
jq
剖析器可確保回應的格式達到最佳可讀性。如需
jq
安裝的相關資訊,請參閱 https://stedolan.github.io/jq/
VMware Aria Suite Lifecycle
的 Postman 集合在 的 [
說明文件
] 索引標籤上作為範例提供。

驗證

您可以本機使用者身分 (例如 user@local) 存取
VMware Aria Suite Lifecycle
API。本機驗證會使用基本授權要求標頭。
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
    是「username:password」的 Base64 編碼值,其中 username 為 admin@local,password 為 admin@local。若要編碼為 Base64 格式,您可以使用 Web 應用程式,例如 https://www.base64encode.org/
以下要求範例顯示如何使用編碼值為
admin@local:ThisIsPassword
的 Token 進行呼叫。
curl -H "Authorization: Basic YWRtaW5AbG9jYWw6VGhpc0lzUGFzc3dvcmQ=" -k https://vrlcm.vrack.local/lcm/lcops/api/settings/systemsettings