工作區API 2.0

工作區API允許您列出、導入、導出和刪除筆記本和文件夾。對Workspace API的請求允許的最大大小是10MB。看到工作空間的例子獲取如何使用此API的指南。

重要的

要訪問Databricks的REST api，您必須進行身份驗證．

刪除

端點	HTTP方法
`2.0 / workspace /刪除`	`帖子`

刪除對象或目錄(並可選地遞歸刪除目錄中的所有對象)。如果路徑是否不存在，此調用返回錯誤RESOURCE_DOES_NOT_EXIST．如果路徑是否為非空目錄和遞歸設置為假，此調用返回一個錯誤DIRECTORY_NOT_EMPTY．對象刪除無法撤消，遞歸刪除目錄也不是原子的。

例子

要求:

              curl——netrc——請求POST＼https://1234567890123456.7.gcp.www.eheci.com/api/2.0/workspace/delete＼——頭接受:application / json的＼——數據{"path": "/Users/me@example.com/MyFolder"， "recursive": true} "
             

如果成功，此端點不返回響應。

請求結構

字段名	類型	描述
路徑	`字符串`	筆記本或目錄的絕對路徑。此字段為必填項。
遞歸	`保齡球`	指定是否遞歸刪除對象的標誌。它是`假`默認情況下。請注意這個刪除目錄不是原子的。如果中途失敗，可能會刪除該目錄下的部分對象，且無法恢複。

出口

端點	HTTP方法
`2.0 /工作區/出口`	`得到`

導出筆記本或整個目錄的內容。您還可以導出Databricks回購，或從Databricks回購導出筆記本或目錄。您不能從Databricks回購中導出非筆記本文件。如果路徑是否不存在，此調用返回錯誤RESOURCE_DOES_NOT_EXIST．隻能在中導出目錄DBC格式。如果導出的數據超過了大小限製，此調用將返回一個錯誤MAX_NOTEBOOK_SIZE_EXCEEDED．此API不支持導出庫。

例子

要求:

              curl——netrc——請求GET＼https://1234567890123456.7.gcp.www.eheci.com/api/2.0/workspace/export＼——頭接受:application / json的＼——數據{"path": "/Users/me@example.com/MyFolder/MyNotebook"， "format": "SOURCE"， "direct_download": true} "
             

              curl——netrc——請求GET＼https://1234567890123456.7.gcp.www.eheci.com/api/2.0/workspace/export＼——頭接受:application / json的＼——數據{"path": "/Repos/me@example.com/MyFolder/MyNotebook"， "format": "SOURCE"， "direct_download": true} "
             

回應:

如果direct_download菲爾德被設定為假或者在請求中被省略，則返回一個base64編碼的內容版本，例如:

              ｛“內容”：“Ly8gRGF0YWJyaWNrcyBub3RlYm9vayBzb3VyY2UKMSsx”，｝
             

否則,如果direct_download被設定為真正的在請求中，下載內容。

請求結構

字段名	類型	描述
路徑	`字符串`	筆記本或目錄的絕對路徑。導出目錄僅支持`DBC`．此字段為必填項。
格式	ExportFormat	指定導出文件的格式。默認情況下，這是`源`．區分大小寫。
direct_download	`保齡球`	標誌以啟用直接下載。如果是的話`真正的`，則響應將是導出的文件本身。否則，響應包含base64編碼字符串的內容。看到導出筆記本或文件夾有關如何使用它的更多信息。

響應結構

字段名	類型	描述
內容	`字節`	base64編碼的內容。如果超過了限製(10MB)，則會出現錯誤代碼異常`MAX_NOTEBOOK_SIZE_EXCEEDED`拋出。

獲得地位

端點	HTTP方法
`2.0 / workspace /獲得狀態`	`得到`

獲取對象或目錄的狀態。如果路徑是否不存在，此調用返回錯誤RESOURCE_DOES_NOT_EXIST．

例子

要求:

              curl——netrc——請求GET＼https://1234567890123456.7.gcp.www.eheci.com/api/2.0/workspace/get-status＼——頭接受:application / json的＼——數據'{"path": "/Users/me@example.com/MyFolder/MyNotebook"}'
             

回應:

              ｛“object_type”：“筆記本”，“路徑”：“/用戶/ me@example.com/MyFolder/MyNotebook”，“語言”：“巨蟒”，“object_id”：123456789012345｝
             

請求結構

字段名	類型	描述
路徑	`字符串`	筆記本或目錄的絕對路徑。此字段為必填項。

響應結構

字段名	類型	描述
object_type	ObjectType	對象的類型。
object_id	`INT64`	對象的唯一標識符。
路徑	`字符串`	對象的絕對路徑。
語言	語言	對象的語言。隻有當對象類型為時，才需要設置此值`筆記本`．

進口

端點	HTTP方法
`2.0 /工作區/導入`	`帖子`

導入一個筆記本或整個目錄的內容。如果路徑已經存在覆蓋設置為假，此調用返回一個錯誤RESOURCE_ALREADY_EXISTS．你隻能使用DBC格式導入目錄。

例子

導入base64編碼的字符串:

              curl——netrc——請求POST＼https://1234567890123456.7.gcp.www.eheci.com/api/2.0/workspace/import＼——頭接受:application / json的＼——數據“{"path": "/Users/me@example.com/MyFolder/MyNotebook"， "content": " ly8grgf0ywjyawnrcybub3rlys9vaybzb3vyy2ukmssx "， "language": "PYTHON"， "overwrite": true， "format": "SOURCE"}”
             

導入本地文件:

              curl——netrc——請求POST＼https://1234567890123456.7.gcp.www.eheci.com/api/2.0/workspace/import＼——頭“內容類型:多部分/格式”＼——形式路徑＝/用戶/ me@example.com/MyFolder/MyNotebook＼——形式內容＝@myCode.py.zip
             

如果成功，此端點不返回響應。

請求結構

字段名	類型	描述
路徑	`字符串`	筆記本或目錄的絕對路徑。隻支持導入目錄`DBC`格式。此字段為必填項。
格式	ExportFormat	這指定要導入的文件的格式。默認情況下，這是`源`．區分大小寫。
語言	語言	語言。如果format設置為`源`，該字段為必填項;否則，它將被忽略。
內容	`字節`	base64編碼的內容。這有10MB的限製。如果超過了這個限製(10MB)，將出現錯誤代碼異常`MAX_NOTEBOOK_SIZE_EXCEEDED`拋出。此參數可能不存在，取而代之的是使用一個已發布的文件。看到導入一個筆記本或目錄有關如何使用它的更多信息。
覆蓋	`保齡球`	指定是否覆蓋現有對象的標誌。它是`假`默認情況下。為`DBC`格式，不支持覆蓋，因為它可能包含一個目錄。

列表

端點	HTTP方法
`2.0 / workspace /列表`	`得到`

列出目錄的內容，如果不是目錄則列出對象。如果輸入路徑不存在，此調用將返回一個錯誤RESOURCE_DOES_NOT_EXIST．

例子

列出目錄及其內容:

要求:

              curl——netrc——請求GET＼https://1234567890123456.7.gcp.www.eheci.com/api/2.0/workspace/list＼——頭接受:application / json的＼——數據'{"path": "/Users/me@example.com"}'
             

回應:

              ｛“對象”：［｛“路徑”：“/用戶/ me@example.com/MyFolder”，“object_type”：“目錄”，“object_id”：234567890123456}，｛“路徑”：“/用戶/ me@example.com/MyFolder/MyNotebook”，“object_type”：“筆記本”，“語言”：“巨蟒”，“object_id”：123456789012345}，｛“…”｝］｝
             

回購協議:

              curl——netrc——請求GET＼https://1234567890123456.7.gcp.www.eheci.com/api/2.0/workspace/list＼——頭接受:application / json的＼——數據'{"path": "/Repos/me@example.com"}'
             

回應:

              ｛“對象”：［｛“路徑”：“回購/ me@example.com/MyRepo1”，“object_type”：“回購”，“object_id”：234567890123456}，｛“路徑”：“回購/ me@example.com/MyRepo2”，“object_type”：“回購”，“object_id”：123456789012345}，｛“…”｝］｝
             

請求結構

字段名	類型	描述
路徑	`字符串`	筆記本或目錄的絕對路徑。此字段為必填項。

響應結構

字段名	類型	描述
對象	的數組ObjectInfo	對象列表。

mkdir

端點	HTTP方法
`2.0 / workspace / mkdir`	`帖子`

創建給定的目錄和必要的父目錄(如果它們不存在)。如果在輸入路徑的任何前綴處存在一個對象(而不是目錄)，則此調用將返回一個錯誤RESOURCE_ALREADY_EXISTS．如果這個操作失敗，它可能已經成功地創建了一些必要的父目錄。

例子

要求:

              curl——netrc——請求POST＼https://1234567890123456.7.gcp.www.eheci.com/api/2.0/workspace/mkdirs＼——頭接受:application / json的＼——數據'{"path": "/Users/me@example.com/MyFolder"}'
             

如果成功，此端點不返回響應。

請求結構

字段名	類型	描述
路徑	`字符串`	目錄的絕對路徑。如果父目錄不存在，它也會創建它們。如果目錄已經存在，此命令將不執行任何操作並成功。此字段為必填項。

數據結構

在本節中:

ObjectInfo

工作區中對象的信息。它由列表而且獲得狀態．

字段名	類型	描述
object_type	ObjectType	對象的類型。
object_id	`INT64`	對象的唯一標識符。
路徑	`字符串`	對象的絕對路徑。
語言	語言	對象的語言。隻有當對象類型為時，才需要設置此值`筆記本`．

ExportFormat

筆記本電腦的導入和導出格式。

格式	描述
源	筆記本將作為源代碼導入/導出。
超文本標記語言	筆記本將作為HTML文件導入/導出。
JUPYTER	筆記本將作為Jupyter/IPython筆記本文件導入/導出。
DBC	筆記本將以Databricks存檔格式導入/導出。

語言

筆記本語言。

語言	描述
SCALA	Scala的筆記本。
PYTHON	Python的筆記本。
SQL	SQL的筆記本。
R	R筆記本。

ObjectType

工作區中對象的類型。

類型	描述
筆記本	筆記本
目錄	目錄
文件	文件
圖書館	圖書館
回購	存儲庫