您可以使用瀏覽器或 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 提供特定語言的用戶端繫結。請參閱 存取 Swagger 說明文件以取得架構參考。
存取 Swagger 說明文件以取得架構參考
VMware Aria Operations REST API 說明文件包含 VMware Aria Operations API 中所有元素、類型、查詢和作業的參考資料。其中也包含配置定義檔案。
Swagger 型 API 說明文件隨附於產品中,具備直接從登陸頁面進行 REST API 通話的功能。
若要存取 API 說明文件,必須先透過 VMware Aria Operations 執行個體的 URL 登入 VMware Aria Operations。
例如,如果執行個體的 URL 是
https://www.mgmt.cloud.vmware.com,可從下列位置取得 API 參考:
https://www.mgmt.cloud.vmware.com/vrops-cloud/suite-api/doc/swagger-ui.html
。
備註: 如果您的組織位於美國境外,請使用 API 端點的國家/地區縮寫。使用錯誤的端點會導致 404 錯誤。例如,如果您的組織位於澳大利亞,您的國家/地區縮寫為 AU,而且可在下列位置取得您的 API 說明文件:
https://au.www.mgmt.cloud.vmware.com/vrops-cloud/suite-api/doc/swagger-ui.html
特定語言的用戶端繫結位於:
https://www.mgmt.cloud.vmware.com/vrops-cloud/suite-api/
關於 VMware Aria Operations API 範例
所有範例包括 HTTP 要求和回應。這些範例會顯示與作業相關聯的工作流程和內容,例如建立和查詢受監控環境中物件的相關資訊。
範例要求內文以 JSON 撰寫。範例要求中包含 VMware Aria Operations API 所需的要求標頭,這些並非較大範例的片段。
大多數的範例回應僅顯示與所討論作業相關的元素和屬性。省略符號 (...) 代表回應內文中省略的內容。