Skip to main content
SnapCenter software
本繁體中文版使用機器翻譯，譯文僅供參考，若與英文版本牴觸，應以英文版本為準。

如何使用 Swagger API 網頁存取 REST API

PDF

REST API 透過 Swagger 網頁公開。您可以造訪 Swagger 網頁來顯示SnapCenter Server REST API，以及手動發出 API 呼叫。您可以使用 REST API 來協助管理您的SnapCenter伺服器或執行資料保護作業。

您應該知道要執行 REST API 的SnapCenter伺服器的管理 IP 位址或網域名稱。

您不需要特殊權限來執行 REST API 用戶端。任何使用者都可以造訪 Swagger 網頁。透過 REST API 存取的物件上的相應權限取決於產生用於登入 REST API 的令牌的使用者。

步驟

  1. 在瀏覽器中，輸入 URL 以存取 Swagger 網頁，格式為 https://<SnapCenter_IP_address_or_name>:<SnapCenter_port>/swagger/。

    註 確保 REST API URL 不包含以下字元：+、.、% 和 &。

  2. 在 Swagger Explore 欄位中，如果 Swagger API 文件未自動顯示，請鍵入：https://<SnapCenter_IP_address_or_name>:<SnapCenter_port>/Content/swagger/ SnapCenter.yaml

  3. 按一下“探索”。

    顯示 API 資源類型或類別的清單。

  4. 按一下 API 資源類型可顯示該資源類型中的 API。

如果在執行SnapCenter REST API 時遇到意外行為，您可以使用日誌檔案找出原因並解決問題。您可以透過點擊「監控」>「日誌」>「下載」從SnapCenter使用者介面下載日誌檔案。