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 Aria Suite Lifecycle
Swagger 文档也可以从 VMware Developer 站点公开获取。请参见VMware Aria Suite Lifecycle REST API
如果对公共 API 进行任何重大更改,
VMware
会提前 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 集合在
文档
选项卡上作为示例提供。

身份验证

您以本地用户身份访问
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
    是“username:password”的 Base64 编码值,用户名是 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