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

REST Web服務基礎

貢獻者

代表性狀態傳輸(REST)是建立分散式Web應用程式的風格。當套用到Web服務API的設計時、它會建立一套技術、以揭露伺服器型資源並管理其狀態。它使用主流傳輸協定和標準、為ONTAP 管理等叢集提供靈活的基礎。

註 REST建立一套通用的技術和最佳實務做法、但每個API的詳細資料可能會因開發期間所做的選擇而有所不同。在使用即時部署之前、您應該先瞭解ONTAP 到靜態API的設計特性。

資源和狀態表示

資源是網路型系統的基本元件。建立REST Web服務應用程式時、早期的設計工作包括:

  • 識別系統或伺服器型資源

    每個系統都會使用及維護資源。資源可以是檔案、商業交易、程序或管理實體。根據REST Web服務設計應用程式的首要任務之一、就是識別資源。

  • 資源狀態和相關狀態作業的定義

    資源永遠處於有限的狀態之一。必須清楚定義狀態、以及用來影響狀態變更的相關作業。

URI端點

每個REST資源都必須使用明確定義的定址方案來定義和提供。資源所在及識別的端點使用統一資源識別元(URI)。URI提供一般架構、可為網路中的每個資源建立唯一名稱。統一資源定位器(URL)是一種與Web服務搭配使用的URI、用於識別及存取資源。資源通常會以階層式結構公開、類似檔案目錄。

HTTP訊息

超文字傳輸傳輸協定(HTTP)是Web服務用戶端和伺服器用來交換有關資源的要求和回應訊息的傳輸協定。在設計Web服務應用程式時、HTTP方法會對應至資源及對應的狀態管理動作。HTTP為無狀態。因此、若要將一組相關的要求和回應建立關聯、以做為一筆交易的一部分、則必須在隨要求和回應資料流一起提供的HTTP標頭中加入額外資訊。

JSON格式化

雖然資訊可透過多種方式在Web服務用戶端和伺服器之間進行結構化和傳輸、但最受歡迎的選項是JavaScript物件表示法(Json)。Json是以純文字表示簡單資料結構的產業標準、用於傳輸描述資源的狀態資訊。這個靜態API使用Json來格式化每個HTTP要求和回應的實體中所包含的資料。ONTAP

典型 REST API 交易

每筆API交易都包含HTTP要求和相關回應。本圖例說明如何擷取ONTAP 叢集所使用的版本的資訊。

簡單REST API呼叫的圖例

HTTP要求

從用戶端傳送到伺服器的要求包含下列項目:

  • 取得動詞

  • 叢集的URL路徑

  • 查詢參數(欄位)

  • 要求標頭、包括授權

HTTP回應

從伺服器傳送到用戶端的回應包含下列項目:

  • 狀態代碼200

  • 回應標頭

  • 包含叢集軟體版本的回應本文