您可以使用浏览器或 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 提供特定语言的客户端绑定。
关于架构参考
VMware Aria Operations REST API 文档包括 VMware Aria Operations API 中所有元素、类型、查询和操作的参考资料。还包括架构定义文件。
产品可提供基于 Swagger 的 API 文档,并且能够从登录页直接进行 REST API 调用。
要访问 API 文档,请使用
VMware Aria Operations 云代理的 URL。例如,如果云代理的 URL 是
https://www.cloudproxy.vmware.com,则可从
https://cloudproxy.vmware.com/suite-api/doc/swagger-ui.html
获得 API 参考资料。
注: 您必须在 URL 中使用云代理 IP 或 FDQN 才能访问 API 文档。
可从以下位置获取特定语言的客户端绑定:
https://www.cloudproxy.vmware.com/vrops-cloud/suite-api/
授权 VMware Aria Operations API
要执行 API 调用,必须使用访问令牌在 Swagger UI 中授权 VMware Aria Operations 云代理。输入 CSP 令牌 (apiKey) 值,然后单击 授权。
关于 VMware Aria Operations API 示例
所有示例都包含 HTTP 请求和响应。这些示例显示与操作相关联的工作流和内容,例如,创建和查询有关受监控环境中的对象的信息。
示例请求正文采用 JSON 格式。VMware Aria Operations API 所需的请求标头包含在不属于较大示例的片段的示例请求中。
大多数示例响应仅显示与所讨论操作相关的元素和属性。省略号 (...) 表示响应正文中省略的内容。