磚REST API參考

身份驗證

驗證到REST API的更多信息,請參閱身份驗證使用磚個人的訪問令牌。API的例子,請參閱API的例子。

速度限製

以確保高質量的服務負載較重的情況下,磚實施速度限製為所有的REST API調用。限製設置每個端點和工作區,以確保公平用法和高可用性。

請求返回一個超過速度限製429響應狀態碼。

解析輸出

它可以是有用的解析JSON輸出部分。磚建議實用程序金橋解析JSON。你可以安裝金橋在Linux上通過金橋版本macOS用自製程序釀造安裝金橋,或者在Windows上使用巧克力色喬科省安裝金橋。的更多信息金橋,請參閱金橋手冊。

這個示例列出名稱和id指定的工作區中可用的集群。這個示例使用. netrc文件。

curl https://1234567890123456.7.gcp.m.eheci.com/api/2.0/clusters/list——netrc - x\|金橋“[.clusters [] | {id: .cluster_id,名字:.cluster_name}]”

({“id”:“1234 - 567890 batch123”,“名稱”:“我的集群1”},{“id”:“2345 - 678901 rigs234”,“名稱”:“我的集群2”}]

兼容性

反應相同的API版本將不會刪除任何領域從JSON輸出。然而,API會將新字段添加到JSON輸出而不增加API版本。你的編程工作流程必須意識到這些增加和忽略未知的領域。

一些字符串字段(包含錯誤和描述性信息旨在使用UI)是結構化的,和你不應該依賴於這些字段的格式編程工作流。

使用curl來調用數據磚REST API

旋度是一個流行的工具和從服務器傳輸數據。本節提供具體信息使用curl來調用數據磚REST API。

curl——netrc“https://1234567890123456.7.gcp.m.eheci.com/api/2.0/clusters/get?cluster_id=1234 - 567890 patch123”

curl——netrc\https://1234567890123456.7.gcp.m.eheci.com/api/2.0/clusters/get\——數據cluster_id=1234年567890 - batch123

{“cluster_id”:“1234 - 567890 batch123”,"司機":{" node_aws_attributes ": {“is_spot”:假的},:“private_ip 127.0.0.1”},“cluster_name”:“我的集群”,…}

使用Python來調用數據磚REST API

請求是一個流行的庫進行HTTP請求在Python中。下麵的例子使用了請求庫指定磚集群的信息列表。這個示例使用. netrc文件。

進口請求進口json即instance_id=“1234567890123456.7.gcp.m.eheci.com”api_version=' / api / 2.0 'api_command=/集群/得到的url=f“https://{即instance_id}{api_version}{api_command}”參數個數={“cluster_id”:“1234 - 567890 batch123”}響應=請求。得到(url=url,參數個數=參數個數)打印(json。轉儲(json。加載(響應。文本),縮進=2))

{“cluster_id”:“1234 - 567890 batch123”,"司機":{…},“spark_context_id”: 1234567890123456789,…}

PowerShell調用磚REST API的使用

下麵的例子使用了Invoke-RestMethodcmdlet在PowerShell指定數據磚集群的信息列表。

美元的令牌=“dapia1b2345678901c23456defa7bcde8fa9”ConvertedToken美元=美元的令牌|ConvertTo-SecureString-AsPlainTextforceInstanceID美元=“1234567890123456.7.gcp.m.eheci.com”APIVersion美元=' / api / 2.0 'APICommand美元=/集群/得到的美元的Uri=“https:// InstanceID APIVersion美元APICommand美元”美元的身體=@ {“cluster_id”=“1234 - 567890 batch123”}美元的反應=Invoke-RestMethod”身份驗證持票人”令牌ConvertedToken美元”方法得到”uri美元的Uri”身體美元的身體寫輸出美元的反應

cluster_id: 1234 - 567890 - batch123司機:…spark_context_id: 1234567890123456789…

運行時版本字符串

許多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火花

• 6.4.x-esr-scala2.11代表磚6.4運行時擴展支持並使用Scala 2.11版本編譯2.4.5火花版本

的磚運行時版本和支持計劃的支持和不支持的版本表映射磚到火花版本包含在運行時版本的運行時。

你可以得到一個可用的磚列表字符串通過調用運行時版本運行時版本API。