工作区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://dbc-a1b2345c-d6e7.cloud.www.neidfyre.com/api/2.0/workspace/delete＼——头接受:application / json的＼——数据'{"path": "/Users/me@example.com/MyFolder"， "recursive": true}'
             

如果成功，该端点不返回响应。

请求结构

字段名	类型	描述
路径	`字符串`	笔记本或目录的绝对路径。该字段为必填项。
递归	`保龄球`	指定是否递归删除对象的标志。它是`假`默认情况下。请注意，此删除目录不是原子的。如果中途失败，则该目录下的某些对象可能被删除且无法撤消。

出口

端点	HTTP方法
`2.0 /工作区/出口`	`得到`

导出一个笔记本或整个目录的内容。您还可以导出Databricks Repo，或从Databricks Repo导出笔记本或目录。不能从Databricks回购中导出非笔记本文件。如果路径不存在，此调用是否返回错误RESOURCE_DOES_NOT_EXIST．只能导出目录DBC格式。如果导出的数据超过大小限制，此调用将返回一个错误MAX_NOTEBOOK_SIZE_EXCEEDED．此API不支持导出库。

例子

要求:

              curl—netrc—请求GET＼https://dbc-a1b2345c-d6e7.cloud.www.neidfyre.com/api/2.0/workspace/export＼——头接受:application / json的＼——数据“{"path": "/Users/me@example.com/MyFolder/MyNotebook"， "format": "SOURCE"， "direct_download": true}”
             

              curl—netrc—请求GET＼https://dbc-a1b2345c-d6e7.cloud.www.neidfyre.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://dbc-a1b2345c-d6e7.cloud.www.neidfyre.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://dbc-a1b2345c-d6e7.cloud.www.neidfyre.com/api/2.0/workspace/import＼——头接受:application / json的＼——数据{"path": "/Users/me@example.com/MyFolder/MyNotebook"， "content": "Ly8gRGF0YWJyaWNrcyBub3RlYm9vayBzb3VyY2UKMSsx"， "language": "PYTHON"， " override ": true， "format": "SOURCE"}
             

导入本地文件:

              curl—netrc—请求POST＼https://dbc-a1b2345c-d6e7.cloud.www.neidfyre.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://dbc-a1b2345c-d6e7.cloud.www.neidfyre.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://dbc-a1b2345c-d6e7.cloud.www.neidfyre.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://dbc-a1b2345c-d6e7.cloud.www.neidfyre.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 notebook文件的形式导入/导出。
DBC	笔记本将以Databricks存档格式导入/导出。

语言

笔记本的语言。

语言	描述
SCALA	Scala的笔记本。
PYTHON	Python的笔记本。
SQL	SQL的笔记本。
R	R笔记本。

ObjectType

工作区中对象的类型。

类型	描述
笔记本	笔记本
目录	目录
文件	文件
图书馆	图书馆
回购	存储库