工作區API 2.0

工作區API允許您列出,進口,出口和刪除筆記本和文件夾。請求的最大允許大小工作區API是10 mb。看到集群日誌提供的例子如何引導這個API。

重要的

訪問數據磚REST api,你必須進行身份驗證。

刪除

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

刪除一個對象或一個目錄(和可選的遞歸刪除目錄中的所有對象)。如果路徑不存在,這個調用返回一個錯誤呢RESOURCE_DOES_NOT_EXIST。如果路徑是一個非空目錄和遞歸被設置為假,這個調用返回一個錯誤DIRECTORY_NOT_EMPTY。對象刪除無法回複和刪除一個目錄遞歸地不是原子。

例子

要求:

              curl——netrc POST請求\https://dbc-a1b2345c-d6e7.cloud.m.eheci.com/api/2.0/workspace/delete\——頭接受:application / json的\——數據”{“路徑”:“/用戶/ me@example.com/MyFolder”,“遞歸”:真正}”
             

如果成功,該端點返回沒有回應。

請求結構

字段名	類型	描述
路徑	`字符串`	筆記本或目錄的絕對路徑。這個字段是必需的。
遞歸	`BOOL`	標記,用於指定是否要遞歸地刪除對象。它是`假`默認情況下。請注意這個刪除目錄不是原子。如果不能在中間,一些該目錄下的對象可能被刪除,無法回複。

出口

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

出口一個筆記本或整個目錄的內容。您還可以導出數據磚回購,或一個筆記本從磚回購或目錄。如果路徑不存在,這個調用返回一個錯誤呢RESOURCE_DOES_NOT_EXIST。隻有在您可以導出一個目錄DBC格式。如果導出的數據超過大小限製,這個調用返回一個錯誤MAX_NOTEBOOK_SIZE_EXCEEDED或BAD_REQUEST。這個API不支持導出一個圖書館。

例子

出口一個筆記本

要求:

               curl——netrc請求\https://dbc-a1b2345c-d6e7.cloud.m.eheci.com/api/2.0/workspace/export\——頭接受:application / json的\——數據”{“路徑”:“/用戶/ me@example.com/MyFolder/MyNotebook”,“格式”:“源”、“direct_download”:真正}”
              

               curl——netrc請求\https://dbc-a1b2345c-d6e7.cloud.m.eheci.com/api/2.0/workspace/export\——頭接受:application / json的\——數據”{“路徑”:“回購/ me@example.com/MyFolder/MyNotebook”,“格式”:“源”、“direct_download”:真正}”
              

回應:

如果direct_download字段被設置為假或者是省略了從請求,返回base64編碼版本的內容,例如:

               {“內容”:“Ly8gRGF0YWJyaWNrcyBub3RlYm9vayBzb3VyY2UKMSsx”,}
              

否則,如果direct_download被設置為真正的請求的內容下載。

導出一個工作區文件

這個功能是在公共預覽。

要求:

               curl——netrc請求\https://dbc-a1b2345c-d6e7.cloud.m.eheci.com/api/2.0/workspace/export\——頭接受:application / json的\——數據”{“路徑”:“/用戶/ me@example.com/MyRepo/my_file.txt”,“格式”:“汽車”,“direct_download”:真正}”
              

回應:

如果direct_download字段被設置為假或者是省略了從請求,返回base64編碼版本的內容,例如:

               {“內容”:“Ly8gRGF0YWJyaWNrcyBub3RlYm9vayBzb3VyY2UKMSsx”,}
              

否則,如果direct_download被設置為真正的請求的內容下載。

請求結構

字段名	類型	描述
路徑	`字符串`	筆記本或目錄的絕對路徑。出口隻支持一個目錄`DBC`。這個字段是必需的。
格式	ExportFormat	這個指定的格式導出文件。默認情況下,這是`源`。值是區分大小寫的。
direct_download	`BOOL`	國旗使直接下載。如果它是`真正的`,響應將導出的文件本身。否則,響應包含內容為base64編碼的字符串。看到出口一個筆記本或文件夾為更多的信息關於如何使用它。

響應結構

字段名	類型	描述
內容	`字節`	base64編碼的內容。如果超出極限(10 mb),異常和錯誤代碼`MAX_NOTEBOOK_SIZE_EXCEEDED`拋出。

獲得地位

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

得到一個對象或一個目錄的狀態。如果路徑不存在,這個調用返回一個錯誤呢RESOURCE_DOES_NOT_EXIST。

例子

要求:

              curl——netrc請求\https://dbc-a1b2345c-d6e7.cloud.m.eheci.com/api/2.0/workspace/get-status\——頭接受:application / json的\——數據{“路徑”:”/用戶/ 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://dbc-a1b2345c-d6e7.cloud.m.eheci.com/api/2.0/workspace/import\——頭接受:application / json的\——數據”{“路徑”:“/用戶/ me@example.com/MyFolder/MyNotebook”,“內容”:“Ly8gRGF0YWJyaWNrcyBub3RlYm9vayBzb3VyY2UKMSsx”,“語言”:“PYTHON”、“覆蓋”:真的,“格式”:“源”}”
             

導入本地筆記本:

              curl——netrc POST請求\https://dbc-a1b2345c-d6e7.cloud.m.eheci.com/api/2.0/workspace/import\——頭“內容類型:多部分/格式”\——形式路徑=/用戶/ me@example.com/MyFolder/MyNotebook\——形式內容=@myCode.py.zip
             

導入本地文件(公共預覽):

              curl——netrc POST請求\https://dbc-a1b2345c-d6e7.cloud.m.eheci.com/api/2.0/workspace/import\——頭“內容類型:多部分/格式”\——形式路徑=/回購/ me@example.com/MyRepo/my_file.py\——形式格式=汽車\——形式內容=@non-notebook.py
             

如果成功,該端點返回沒有回應。

請求結構

字段名	類型	描述
路徑	`字符串`	筆記本或目錄的絕對路徑。導入目錄隻是支持`DBC`格式。這個字段是必需的。
格式	ExportFormat	這將指定的格式文件導入。默認情況下,這是`源`。值是區分大小寫的。
語言	語言	語言。如果格式設置`源`這個字段是必需的;否則,它將被忽略。
內容	`字節`	base64編碼的內容。這10 MB的限製。如果超出極限(10 MB),異常和錯誤代碼`MAX_NOTEBOOK_SIZE_EXCEEDED`拋出。這個參數可能會缺席,而是將使用發布文件。看到導入一個筆記本或目錄為更多的信息關於如何使用它。
覆蓋	`BOOL`	標記,用於指定是否覆蓋現有對象。它是`假`默認情況下。為`DBC`格式不支持覆蓋,因為它可能包含一個目錄。

列表

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

列出一個目錄的內容,或對象如果它不是一個目錄。如果輸入路徑不存在,這個調用返回一個錯誤RESOURCE_DOES_NOT_EXIST。

例子

列表目錄及其內容:

要求:

              curl——netrc請求\https://dbc-a1b2345c-d6e7.cloud.m.eheci.com/api/2.0/workspace/list\——頭接受:application / json的\——數據{“路徑”:”/用戶/ me@example.com”}”
             

回應:

              {“對象”:({“路徑”:“/用戶/ me@example.com/MyFolder”,“object_type”:“目錄”,“object_id”:234567890123456},{“路徑”:“/用戶/ me@example.com/MyFolder/MyNotebook”,“object_type”:“筆記本”,“語言”:“巨蟒”,“object_id”:123456789012345},{“…”}]}
             

回購協議:

              curl——netrc請求\https://dbc-a1b2345c-d6e7.cloud.m.eheci.com/api/2.0/workspace/list\——頭接受:application / json的\——數據{“路徑”:”/回購/ 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://dbc-a1b2345c-d6e7.cloud.m.eheci.com/api/2.0/workspace/mkdirs\——頭接受:application / json的\——數據{“路徑”:”/用戶/ me@example.com/MyFolder”}”
             

如果成功,該端點返回沒有回應。

請求結構

字段名	類型	描述
路徑	`字符串`	目錄的絕對路徑。如果父目錄不存在,它還將創建它們。如果目錄已經存在,這個命令將什麼都不做,成功。這個字段是必需的。

數據結構

在本節中:

ObjectInfo

工作區中的對象的信息。這是返回的列表和獲得狀態。

字段名	類型	描述
object_type	ObjectType	對象的類型。
object_id	`INT64`	唯一標識符的對象。
路徑	`字符串`	對象的絕對路徑。
語言	語言	對象的語言。這個值設置隻有在對象類型`筆記本`。

ExportFormat

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

格式	描述
汽車	(公共預覽)項目導入/導出為一個工作區文件或一個筆記本,取決於一個分析項目的擴展和標題內容提供的請求。另請參閱導入一個文件,並將它轉換成一個筆記本。如果項目進口的筆記本,則自動刪除項的擴展。
源	筆記本將導入/導出為源代碼。
HTML	筆記本將導入/導出為HTML文件。
JUPYTER	筆記本將導入/導出為Jupyter IPython筆記本文件。
DBC	筆記本將導入/導出為磚檔案格式。

語言

筆記本電腦的語言。

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

ObjectType

工作區中的對象的類型。

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