Cloudera Manager API v18

介紹

本文檔描述了Cloudera Manager REST API。å所有請求和響應都以Javascript對象表示法(JSON)表示。

下面列出的API資源遵循標準的createread-update - delete (CRUD)語義,其中HTTP請求路徑定義要執行的實體,而HTTP方法表示要執行的操作類型。

HTTP Method Operation
POST Create entries
GET Read entries
PUT Update or edit entries
DELETE Delete entries

API中的所有集合都使用複數名稱“users”,而不是單數“user”。要在系統中尋址特定的用戶,請展開URL路徑以包含用戶標識符。例如,'/users/foo'標識用戶'foo'和'/users/bar'標識用戶'bar'。

Collection POST (create) GET (read) PUT (update) DELETE (delete)
/users Create a new user List all users in the system Bulk update all users Delete all users
/users/foo error Read information about user 'foo' If user 'foo' exists, update their information; otherwise, error. Delete user 'foo'

請記住,並非所有集合都支持所有操作。例如,系統中的事件是隻讀的;不能使用API創建新的事件。

您可以使用以下兩種視圖之一列出集合中的條目:“summary”或“full”。默認的“summary”視圖提供關於每個條目的核心信息。“full”視圖更重量級,爲每個條目提供了完整的擴展視圖。視圖由一個名爲“view”的查詢參數控制。“GET /users?view=full”。

對於大多數調用,HTTP請求應該將“Content-Type”標頭設置爲“application/json”,除非另有規定。

身份驗證

Cloudera Manager API使用了HTTP基本訪問身份驗證。它接受與web界面相同的用戶憑證。不同的用戶可能有不同的訪問級別,由他們的角色定義。(請參閱用戶管理API要求更多。)對於每個經過身份驗證的請求,服務器都返回一個會話cookie,可以隨後用於身份驗證。

錯誤

API在錯誤時返回400s和500s中的HTTP代碼:

400 -無效的請求參數;畸形的請求
401 -身份驗證失敗
403 -授權失敗
404 -未找到對象
內部API錯誤
503 -響應暫時不可用;調用者應該稍後重試
有關錯誤響應的主體的討論,請參見/tools/echoError。

API的使用教程

Tutorial link.

API 版本

可以查詢API以獲取它支持的最新版本。通過向'/version' URL發出GET請求,將返回一個具有最高支持版本(例如,“v2”)的字符串。

請注意,僅支持API v1的服務器不支持此調用。在這種情況下,將返回404錯誤,並可用於檢測服務器僅支持v1。

該版本應該預寫到下面列出的其餘資源的路徑。不同資源的文檔列出了添加特定功能的版本。

API Version

可以查詢API以獲取它支持的最新版本。通過向'/version' URL發出GET請求,將返回一個具有最高支持版本(例如,“v2”)的字符串。

請注意,僅支持API v1的服務器不支持此調用。在這種情況下,將返回404錯誤,並可用於檢測服務器僅支持v1。

該版本應該預寫到下面列出的其餘資源的路徑。不同資源的文檔列出了添加特定功能的版本。

REST資源

此API支持通過一組固定的操作訪問一組資源的代表性狀態傳輸(Representational State Transfer, REST)模型。通過RESTful模型可以訪問以下資源:

這也是一個描述REST API的WADL文檔。

數據模型

所有端點都對一組公共數據進行操作。Cloudera Manager API使用了JSON。

數據元素

轉自:https://blog.csdn.net/sccdcwc/article/details/81173002

參考:https://www.cloudera.com/documentation/enterprise/latest/topics/cm_intro_api.html

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章