授權與驗證
貢獻者
NetApp 服務引擎 REST API 可透過任何可發出 HTTP 要求的網頁瀏覽器或程式設計平台來存取。NetApp 服務引擎支援基本 HTTP 驗證機制、以及 Java Web Token ( JWT )承載驗證。在呼叫 API 之前、您必須先驗證使用者。
HTTP 狀態代碼
在執行 API 或疑難排解問題時、您應該注意 NetApp 服務引擎 API 所使用的各種 HTTP 狀態代碼和錯誤代碼。
下表列出與驗證相關的錯誤代碼。
HTTP 狀態代碼 | 狀態代碼標題 | 說明 |
---|---|---|
200 |
好的 |
成功執行同步 API 呼叫時傳回。 |
201. |
已建立 |
透過同步呼叫(例如 Active Directory 組態)來建立新資源。 |
202.02 |
已接受 |
成功執行非同步呼叫以進行資源配置功能(例如建立 LUN 和檔案共用)時傳回。 |
400 |
無效要求 |
表示輸入驗證失敗。使用者必須修正輸入、例如要求內容中的有效金鑰。 |
401. |
未獲授權的要求 |
您無權檢視資源 / 未獲授權。 |
403. |
禁止的要求 |
禁止存取您嘗試存取的資源。 |
404.. |
找不到資源 |
找不到您要聯絡的資源。 |
405 |
不允許使用方法 |
不允許使用方法。 |
412. |
先決條件失敗 |
一或多項先決條件未達成。 |
500 |
內部伺服器錯誤 |
內部伺服器錯誤。無法從伺服器取得回應。此內部伺服器錯誤可能是永久性的、也可能不是永久性的。例如、如果您執行「 Get 」(取得)或「 Get all 」(取得全部)作業並收到此錯誤、建議您至少重複此作業五次。如果是永久性錯誤、則傳回的狀態代碼仍為 500 。如果作業成功、則傳回的狀態代碼為 200 。 |
使用 API 的建議
使用 API 時、您應遵循某些建議實務做法:
-
若要有效執行、請確定所有回應內容類型都採用下列格式:
application/json
-
更新陣列值時、您必須更新整個值字串。您無法將值附加至陣列、只能取代現有的陣列。
-
使用篩選運算子萬用字元( `* )和管道( `| )組合、避免查詢物件。它可能會擷取不正確的物件數。