工作区 APIWorkspace API

• 08/20/2020
• • m

使用工作区 API 可列出、导入、导出和删除笔记本和文件夹。The Workspace API allows you to list, import, export, and delete notebooks and folders. 对工作区 API 的请求的最大允许大小为 10MB。The maximum allowed size of a request to the Workspace API is 10MB. 有关此 API 的操作方法指南，请参阅工作区示例。See Workspace examples for a how to guide on this API.

删除 Delete

删除对象或目录（可以选择以递归方式删除目录中的所有对象）。Delete an object or a directory (and optionally recursively deletes all objects in the directory). 如果 path 不存在，则此调用会返回错误 RESOURCE_DOES_NOT_EXIST。If path does not exist, this call returns an error RESOURCE_DOES_NOT_EXIST. 如果 path 为非空目录且 recursive 设置为 false，则此调用会返回错误 DIRECTORY_NOT_EMPTY。If path is a non-empty directory and recursive is set to false, this call returns an error DIRECTORY_NOT_EMPTY. 对象删除无法撤消，且以递归方式删除目录不是原子操作。Object deletion cannot be undone and deleting a directory recursively is not atomic. 请求的示例：Example of request:

{
  "path": "/Users/user@example.com/project",
  "recursive": true
}

请求结构 Request structure

导出 Export

导出笔记本或整个目录的内容。Export a notebook or contents of an entire directory. 如果 path 不存在，则此调用会返回错误 RESOURCE_DOES_NOT_EXIST。If path does not exist, this call returns an error RESOURCE_DOES_NOT_EXIST. 只能以 DBC 格式导出目录。You can export a directory only in DBC format. 如果导出的数据超过大小限制，则此调用会返回错误 MAX_NOTEBOOK_SIZE_EXCEEDED。If the exported data exceeds the size limit, this call returns an error MAX_NOTEBOOK_SIZE_EXCEEDED. 此 API 不支持导出库。This API does not support exporting a library. 请求的示例：Example of request:

{
  "path": "/Users/user@example.com/project/ScalaExampleNotebook",
  "format": "SOURCE"
}

响应的示例，其中 content 已进行 base64 编码：Example of response, where content is base64-encoded:

{
  "content": "Ly8gRGF0YWJyaWNrcyBub3RlYm9vayBzb3VyY2UKMSsx",
}

也可通过启用 direct_download 来下载导出的文件：Alternatively, you can download the exported file by enabling direct_download:

curl -n -o example.scala \
  'https://<databricks-instance>/api/2.0/workspace/export?path=/Users/user@example.com/ScalaExampleNotebook&direct_download=true'

在以下示例中，请将 <databricks-instance> 替换为 Azure Databricks 部署的工作区 URL。In the following examples, replace <databricks-instance> with the workspace URL of your Azure Databricks deployment.

请求结构 Request structure

响应结构 Response structure

获取状态 Get status

获取对象或目录的状态。Gets the status of an object or a directory. 如果 path 不存在，则此调用会返回错误 RESOURCE_DOES_NOT_EXIST。If path does not exist, this call returns an error RESOURCE_DOES_NOT_EXIST. 请求的示例：Example of request:

{
  "path": "/Users/user@example.com/project/ScaleExampleNotebook"
}

响应的示例：Example of response:

{
  "path": "/Users/user@example.com/project/ScalaExampleNotebook",
  "language": "SCALA",
  "object_type": "NOTEBOOK",
  "object_id": 789
}

请求结构 Request structure

响应结构 Response structure

导入 Import

导入笔记本或整个目录的内容。Import a notebook or the contents of an entire directory. 如果 path 已存在并且 overwrite 设置为 false，则此调用会返回错误 RESOURCE_ALREADY_EXISTS。If path already exists and overwrite is set to false, this call returns an error RESOURCE_ALREADY_EXISTS. 只能使用 DBC 格式来导入目录。You can use only DBC format to import a directory. 请求的示例，其中 content 是 1+1 的 base64 编码字符串：Example of request, where content is the base64-encoded string of 1+1:

{
  "content": "MSsx\n",
  "path": "/Users/user@example.com/project/ScalaExampleNotebook",
  "language": "SCALA",
  "overwrite": true,
  "format": "SOURCE"
}

也可直接导入本地文件。Alternatively, you can import a local file directly.

在以下示例中，请将 <databricks-instance> 替换为 Azure Databricks 部署的工作区 URL。In the following examples, replace <databricks-instance> with the workspace URL of your Azure Databricks deployment.

curl -n -F path=/Users/user@example.com/project/ScalaExampleNotebook -F language=SCALA \
  -F content=@example.scala \
  https://<databricks-instance>/api/2.0/workspace/import

请求结构 Request structure

列表 List

列出目录的内容，如果不是目录，则列出对象。List the contents of a directory, or the object if it is not a directory. 如果输入路径不存在，则此调用会返回错误 RESOURCE_DOES_NOT_EXIST。If the input path does not exist, this call returns an error RESOURCE_DOES_NOT_EXIST. 请求的示例：Example of request:

{
  "path": "/Users/user@example.com/"
}

响应的示例：Example of response:

{
  "objects": [
    {
      "path": "/Users/user@example.com/project",
      "object_type": "DIRECTORY",
      "object_id": 123
    },
    {
      "path": "/Users/user@example.com/PythonExampleNotebook",
      "language": "PYTHON",
      "object_type": "NOTEBOOK",
      "object_id": 456
    }
  ]
}

请求结构 Request structure

响应结构 Response structure

Mkdirs Mkdirs

创建给定目录和必要的父目录（如果不存在）。Create the given directory and necessary parent directories if they do not exists. 如果在输入路径的任何前缀处存在一个对象（而不是目录），则此调用会返回错误 RESOURCE_ALREADY_EXISTS。If there exists an object (not a directory) at any prefix of the input path, this call returns an error RESOURCE_ALREADY_EXISTS. 如果此操作失败，可能已成功创建了一些必需的父目录。If this operation fails it may have succeeded in creating some of the necessary parent directories. 请求的示例：Example of request:

{
  "path": "/Users/user@example.com/project"
}

请求结构 Request structure

数据结构 Data structures

本节内容：In this section:

• ObjectInfoObjectInfo
• ExportFormatExportFormat
• 语言Language
• ObjectTypeObjectType

ObjectInfo ObjectInfo

工作区中对象的信息。The information of the object in workspace. 它由 list 和 get-status 返回。It is returned by list and get-status.

ExportFormat ExportFormat

笔记本导入和导出的格式。The format for notebook import and export.

语言 Language

笔记本的语言。The language of notebook.

ObjectType ObjectType

工作区中对象的类型。The type of the object in workspace.