適用於 Dell 開發人員的公開說明文件
如需 VxRail REST 應用程式發展介面 (API) 和其他 Dell 產品的完整開發人員說明文件,請前往
Dell 開發人員 API。若要快速尋找 VxRail 專屬的應用程式發展介面,請篩選「超融合基礎架構」。
如需查詢或更新 DNS 的特定文件,請參閱「系統資訊」-「取得並設定 DNS」:
本文檔可用於創建自定義 curl 命令或集成到應用程式中,例如“postman”或其他應用程式,供更有經驗的使用者使用。
VxRail 內嵌 API 用戶端
使用 VxRail API 的偏好方式 (建議適用於不熟悉 REST API 的使用者) 是利用原生 VxRail Manager API 用戶端。
從 VxRail 7.0.350 版本開始,我們已遷移至以聚光燈為基礎且功能更強大的新介面。
在瀏覽器中輸入 VxRail Manager FQDN/IP 以存取原生 API 用戶端。
< https://VxRail_Manager_IP_or_FQDN>/rest/vxm/api-doc.html
例如,VxRail Manager IP 為 172.168.10.50,因此 URL 會變
https://172.168.10.50/rest/vxm/api-doc.html:
查詢目前的 VxRail 叢集 DNS 組態
若要查詢目前的 DNS 組態,請使用左側面板「系統資訊」區段底下的 v1_sytem_dns_get API:
- 直接 URL 會是 https://172.168.10.50/rest/vxm/api-doc.html#/operations/v1_system_dns_get 但是這些 URL 可能會因版本而異,因此最好在 UI 中導覽。
- 輸入 VxRail vCenter 單一登入 (SSO) 驗證登入資料,這通常是 administrator@vsphere.local,但可能會因您的網域組態而有所不同。
- 按一下傳送要求按鈕以執行 GET 要求:
- API 用戶端會進行驗證,如果我們收到 200 OK 的回應,便會傳回要求的資訊,其中目前的 DNS 伺服器實驗室 IP 為 172.168.10.253,而 VxRail Manager 並未設定為「內部 DNS」,這表示我們使用外部客戶提供的 DNS 伺服器:
更新 VxRail 叢集 DNS IP 伺服器資訊
若要更新目前的 DNS 組態,請使用 v1_system_dns_post API,該介面可在左側面板的「系統資訊」區段底下找到:
- 直接 URL 會是 https://172.168.10.50/rest/vxm/api-doc.html#/operations/v1_system_dns_post 但是,這些 URL 可能會因版本而異,因此最好在 UI 中導航。
- 在「驗證」區段中,輸入 VxRail vCenter SSO 認證登入資料,這通常是 administrator@vsphere.local,但可能會因您的網域組態而有所不同。
- 若要更新 DNS 伺服器,請在三個區域內編輯「正文」區段:
- 「components」區段為選填,「ALL」為預設選項。如果全部設定,則會更換叢集中的所有 DNS 伺服器,包括 VxRail Manager、vCenter 和 ESXi。如果設定為「VXM」,則只會更換 VxRail Manager 的 DNS 伺服器,這是有限的使用案例,因為我們建議所有元件組態保持一致。請注意,「VXM」值僅支援 VCF on VxRail 環境。
- 「vCenter」區段我們必須傳遞系統管理員 SSO 使用者名稱和密碼,這通常與「驗證」區段中的資訊相同,但可以提供不同的管理員層級 SSO 帳戶。
- 「servers」區段,在以下範例中,我們將 DNS 設定為 IP 172.168.10.253
- 請注意 ,新增多個伺服器時,IP 必須以逗號分隔「172.168.10.253,10.8.8.8」。
- 按一下傳送要求按鈕以執行 POST 要求:
- 視叢集中的 ESXi 主機數量而定,此要求可能需要幾分鐘的時間,不過當要求成功完成時,會傳回 200 OK 回應代碼。
如果有未預期的回應代碼。
在不健全的系統中,或可能無法從 ESXi 主機等連接新的 DNS 伺服器。API 用戶端提供了一些基本的錯誤消息指導,並且可以在線找到其他回應錯誤代碼
https://restfulapi.net/http-status-codes/ 例如,這是一個不錯的位置。
如果出現任何未預期的錯誤代碼,請聯絡 Dell 支援部門,以進行額外的故障診斷。
在早期的 VxRail 8.0 版本中,Solve Online 程序參考透過 REST API 更新 VxRail DNS IP 設定。這項功能將會新增至 VxRail UI 附掛程式。
本文為利用 VxRail REST API 經驗較少的客戶提供此活動的指南和範例。
本文中的 IP 資訊來自暫時的虛擬隔離實驗室,不包含客戶/機密 IP 資訊。