磚REST API參考

身份驗證

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

速度限製

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

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

API請求的速率限製的信息,請參閱API率限製。

解析輸出

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

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

curl https://1234567890123456.7.gcp.www.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.www.eheci.com/api/2.0/clusters/get?cluster_id=1234 - 567890 patch123”

curl——netrc\https://1234567890123456.7.gcp.www.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.www.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,…}

郵遞員來調用磚REST API的使用

1. 在郵遞員的應用,創建一個新的HTTP請求(文件>新>HTTP請求)。

2. HTTP動詞下拉列表中,選擇動詞匹配您想調用REST API操作。例如,磚集群信息列表,選擇得到。

3. 為輸入請求URL,首先進入https:// < databricks-instance-name >,在那裏< databricks-instance-name >是你的磚工作區實例名例如,1234567890123456.7.gcp.www.eheci.com。

4. 完成請求URL的路徑匹配您想調用REST API操作。例如,集群的信息列表,使用/ api / 2.0 /集群/。

5. 在授權選項卡,類型列表中,選擇不記名的令牌。

6. 為令牌,輸入您的磚為工作區用戶個人訪問令牌。

   提示

   而不是進入你的工作區實例名例如,1234567890123456.7.gcp.www.eheci.com和你的磚個人工作區用戶為每個調用訪問令牌,你可以定義變量和使用變量在郵遞員。

7. 如果你想調用需要一個REST API操作請求主體,做到以下幾點:

   1. 在頭選項卡中,添加關鍵和價值一雙內容類型REST API和一個可接受的內容類型操作。例如,集群的信息列表,使用的內容類型application / json。

   2. 在身體選項卡上,選擇一個可以接受的身體類型的REST API操作。例如,集群的信息列表,選擇的身體類型生然後JSON。

   3. 輸入請求主體。例如,指定集群的信息列表,輸入以下:

      {“cluster_id”:“1234 - 567890 batch123”}

8. 如果REST API操作你想調用需要任何額外的標題,輸入額外的關鍵和價值對的頭選項卡。例如,集群列表信息,不需要附加頭。

9. 如果REST API操作你想調用需要任何查詢參數,輸入它們關鍵和價值對的參數個數選項卡。例如,集群的信息列表,而不是使用一個請求的身體,您可以使用一個查詢參數的關鍵cluster_id和一個值指定集群的ID,如1234 - 567890 batch123。

10. 點擊發送。任何響應將出現在響應部分的細節身體選項卡。

使用HTTPie磚REST API的調用

https得到1234567890123456.7.gcp.www.eheci.com/api/2.0/clusters/getcluster_id=1234年567890 - batch123#還是……https1234567890123456.7.gcp.www.eheci.com/api/2.0/clusters/getcluster_id= =1234年567890 - batch123#這是相當於旋度與金橋…#卷發——netrc ' https://1234567890123456.7.gcp.www.eheci.com/api/2.0/clusters/get ' - d ' {“cluster_id”:“1234 - 567890”patch123}”|金橋。#還是……#卷發,netrc https://1234567890123456.7.gcp.www.eheci.com/api/2.0/clusters/get?cluster_id = 1234 - 567890 patch123 ' |金橋。

PowerShell調用磚REST API的使用

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

美元的令牌=“dapia1b2345678901c23456defa7bcde8fa9”ConvertedToken美元=美元的令牌|ConvertTo-SecureString-AsPlainTextforceInstanceID美元=“1234567890123456.7.gcp.www.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火花

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

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