VMware Aria Operations API 用戶端會執行 REST 工作流程、向伺服器發出 HTTP 要求,以及從伺服器的回應中擷取所需的資訊。
關於 REST
REST 是 Representational State Transfer 的縮寫,說明使用超文字傳輸通訊協定 (HTTP) 來交換用戶端與伺服器之間物件序列化表示的程式架構樣式特性。在 VMware Aria Operations API 中,這些表示方式為 JSON 或 XML 文件。
在 REST 工作流程中,物件的表示方式會在用戶端與伺服器之間來回傳遞,並明確假設沒有任何一方需要瞭解單一要求或回應中所顯示物件以外的任何物件。包含 URL 之要求或回應的生命週期過後,提供這些文件的 URL 通常仍會存在。
REST API 工作流程
寫來使用 REST API 的應用程式會使用 HTTP 要求,該要求通常由指令碼或其他較高階語言執行遠端程序呼叫,以建立、擷取、更新或刪除 API 定義的物件。在 VMware Aria Operations REST API 中,這些物件是由 XML 配置的集合來定義。作業本身為 HTTP 要求,因此對所有 HTTP 用戶端來說是通用的。
若要寫入 REST API 用戶端應用程式,您僅需瞭解 HTTP 通訊協定,以及 JSON 或 XML 的語義,也就是 VMware Aria Operations API 使用的傳輸格式。若要在此類用戶端中有效使用 API,您必須熟悉下列概念。
- API 支援的物件集及其表示的內容。
- API 表示這些物件的方式。
- 用戶端如何參照其想要運作的物件。
包含 API 要求完整清單的 API 參考。請參閱 存取 Swagger 說明文件以取得架構參考。