使用磚REST API
自動化數據磚的磚REST API允許您使用常見的REST API工具和庫。
調用REST API
磚REST API調用通常包括以下組件:
的工作空間的URL你的磚部署。
REST API操作類型,如
得到,帖子,補丁,或刪除。REST API的操作路徑,如
/ api / 2.0 /集群/為指定集群獲取信息。磚身份驗證信息,比如一個訪問令牌。
任何請求主體(通常以JSON格式)或REST API請求查詢參數所需的操作。
的磚REST API參考提供的信息類型、路徑,任何必要的請求主體或請求查詢參數,和響應(通常以JSON格式),為每個支持的操作。許多這些頁麵還提供請求的身體和響應的例子。
的幾個例子如何使用旋度指定這些組件在本文後麵提供。適應這些例子對於其他常見的REST API工具和庫,看到供應商的文檔。
速度限製
以確保高質量的服務負載較重的情況下,磚實施速度限製為所有的REST API調用。限製設置每個端點和工作區,以確保公平用法和高可用性。
請求返回一個超過速度限製429響應狀態碼。
API請求的速率限製的信息,請參閱API率限製。
使用curl來調用REST API
旋度是一個流行的工具和從服務器傳輸數據。
雖然大多數API調用要求您指定一個JSON的身體,得到電話您可以指定後附加的查詢字符串嗎?和周圍的引用的URL。如果你使用旋度,您可以指定——得到(或- g),——數據(或- d)隨著查詢字符串;你不需要圍繞URL或查詢字符串的引號。
在下麵的例子中,替換https://abc-d1e2345f-a6b2.cloud.m.eheci.com與工作空間的URL你的磚部署。
這個例子打印指定的集群信息。這個示例使用. netrc文件。
使用嗎?:
curl——netrc“https://abc d1e2345f a6b2.cloud.m.eheci.com/api/2.0/clusters/get?cluster_id=1234 - 567890 patch123”
使用——得到和——數據:
curl——netrc\https://abc-d1e2345f-a6b2.cloud.m.eheci.com/api/2.0/clusters/get\——數據cluster_id=1234年567890 - patch123
回應:
{“cluster_id”:“1234 - 567890 patch123”,“spark_context_id”: 123456789012345678,“cluster_name”:“工作- 239 - 1”,:“spark_version 8.1.x-scala2.12”,…}
這個示例列表的內容DBFS根。這個示例使用. netrc文件。
curl——netrc\https://abc-d1e2345f-a6b2.cloud.m.eheci.com/api/2.0/dbfs/list\——數據路徑=/
回應:
“文件”:[{“路徑”:“/ tmp”,“is_dir”:沒錯,“file_size”: 0,“modification_time”: 1547078156000},{“路徑”:“/ my_file.txt”,“is_dir”:假的,“file_size”: 40歲“modification_time”: 1541374426000},…]
運行時版本字符串
許多API調用需要你指定一個磚運行時版本字符串。本節描述的結構在磚REST API的版本字符串。
<米> . <F>。x(- - - - - -cpu][- - - - - -esr][- - - - - -gpu][- - - - - -毫升][- - - - - -光子]- - - - - -scala<scala- - - - - -版本>
在哪裏
米:磚運行時主要版本F:磚運行時的特性cpu(:CPU版本毫升唯一的)esr:擴展支持gpu:GPU-enabled毫升:機器學習光子:光子scala版本用來編譯火花:Scala版本:2.10,2.11,2.12
例如:
7.6.x-gpu-ml-scala2.12代表磚7.6運行時機器學習,是GPU-enabled,使用Scala 2.12版本編譯版本3.0.1火花
的磚運行時版本和支持計劃的支持和不支持的版本表映射磚到火花版本包含在運行時版本的運行時。
你可以得到一個可用的磚列表字符串通過調用運行時版本運行時版本API。