Note
此信息适用于 Databricks CLI 版本 0.205 及更高版本。 The Databricks CLI is in Public Preview.
Databricks CLI use is subject to the Databricks License and Databricks Privacy Notice, including any Usage Data provisions.
The jobs command group within the Databricks CLI allows you to create, edit, and delete jobs. See Lakeflow Jobs.
databricks 作业取消所有运行
取消作业的所有活动运行。 运行以异步方式取消，因此不会阻止启动新运行。
databricks jobs cancel-all-runs [flags]
Arguments
None
选项
--all-queued-runs
用于取消所有排队运行的可选布尔参数。
--job-id int
要取消所有运行的作业的规范标识符。
--json JSON
内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。
databricks 作业取消运行
取消运行。
取消作业运行或任务运行。 此运行以异步方式取消，因此此请求完成时仍可能正在运行。
databricks jobs cancel-run RUN_ID [flags]
Arguments
RUN_ID
此字段为必需字段。
选项
--json JSON
内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。
--no-wait
不要等待到达 TERMINATED 或 SKIPPED 状态
--timeout duration
达到 TERMINATED 或 SKIPPED 状态的最大时间（默认值 20m0s）
databricks 作业创建
创建新作业。
databricks jobs create [flags]
Arguments
None
选项
--json JSON
内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。
databricks 作业删除
删除作业。
databricks jobs delete JOB_ID [flags]
Arguments
JOB_ID
要删除作业的规范标识符。 此字段为必需字段。
选项
--json JSON
内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。
databricks 作业 delete-run
删除非活动运行。 如果该运行处于活动状态，则返回错误。
databricks jobs delete-run RUN_ID [flags]
Arguments
RUN_ID
要删除的运行 ID。
选项
--json JSON
内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。
databricks 作业导出-运行
导出并检索作业运行任务。
databricks jobs export-run RUN_ID [flags]
Arguments
RUN_ID
该运行的规范标识符。 此字段为必需字段。
选项
--views-to-export ViewsToExport
要导出的视图。 支持的值：ALL、CODE、DASHBOARDS
databricks 作业获取
检索单个作业的详细信息。
结果中的大型数组将在超过 100 个元素时分页。 对单个作业的请求将返回该作业的所有属性，以及数组属性的前 100 个元素（任务、job_clusters、环境和参数）。 使用next_page_token字段检查更多结果，并将其值作为后续请求中的page_token传递。 如果任何数组属性具有 100 个以上的元素，则会在后续请求中返回其他结果。 以后的页面上没有其他结果的数组将为空。
databricks jobs get JOB_ID [flags]
Arguments
JOB_ID
要检索其相关信息的作业的规范标识符。 此字段为必需字段。
选项
--page-token string
使用从上一个 GetJob 响应返回的next_page_token请求作业的数组属性的下一页。
databricks 作业 get-run
检索作业运行的元数据。
结果中的大型数组将在超过 100 个元素时分页。 对单个运行的请求将返回该运行的所有属性，以及数组属性的前 100 个元素（任务、job_clusters、job_parameters和repair_history）。 使用next_page_token字段检查更多结果，并将其值作为后续请求中的page_token传递。 如果任何数组属性具有 100 个以上的元素，则会在后续请求中返回其他结果。 以后的页面上没有其他结果的数组将为空。
databricks jobs get-run RUN_ID [flags]
Arguments
RUN_ID
要检索其元数据的运行的规范标识符。 此字段为必需字段。
选项
--include-history
在响应中包含修复历史记录。
--include-resolved-values
在响应中包含解析的参数值。
--page-token string
使用从上一个 GetRun 响应返回next_page_token请求运行数组属性的下一页。
databricks 作业 get-run-output
检索单个任务运行的输出和元数据。 当笔记本任务通过 dbutils.notebook.exit（） 调用返回值时，可以使用此命令检索该值。 Databricks 限制此 API 返回输出的前 5 MB。 若要返回更大的结果，可将作业结果存储在云存储服务中。
This command validates that the run_id parameter is valid and returns an HTTP status code 400 if the run_id parameter is invalid. 运行在 60 天之后会自动删除。 如果要引用超过 60 天的运行结果，则必须在过期之前保存旧的运行结果。
databricks jobs get-run-output RUN_ID [flags]
Arguments
RUN_ID
该运行的规范标识符。
选项
databricks 作业列表
检索作业列表。
databricks jobs list [flags]
Arguments
None
选项
--expand-tasks
是否在响应中包含任务和群集详细信息。
--limit int
要返回的作业数。
--name string
基于确切（不区分大小写）作业名称的列表的筛选器。
--offset int
要返回的第一个作业相对于最近创建的作业的偏移量。
--page-token string
使用从上一个请求返回的next_page_token或prev_page_token分别列出下一页或上一页作业。
databricks 作业列表运行
按开始时间按降序列出作业运行。
databricks jobs list-runs [flags]
Arguments
None
选项
--active-only
如果active_only为 true，则结果中仅包含活动运行;否则，列出活动运行和已完成的运行。
--completed-only
如果completed_only为 true，则结果中仅包含已完成的运行;否则，列出活动运行和已完成的运行。
--expand-tasks
是否在响应中包含任务和群集详细信息。
--job-id int
要列出其运行的作业。
--limit int
要返回的运行数。
--offset int
要返回的第一个运行的偏移量（相对于最近的运行）。
--page-token string
使用从上一个请求返回的next_page_token或prev_page_token分别列出下一页或上一页的运行。
--run-type RunType
要返回的运行类型。 支持的值：[JOB_RUN、SUBMIT_RUN、WORKFLOW_RUN]
--start-time-from int
显示从此值 开始或之后 的运行。
--start-time-to int
显示从此值 开始或之前 开始的运行。
databricks 作业修复运行
重新运行一个或多个作业任务。 任务作为原始作业运行的一部分重新运行。 它们使用当前作业和任务设置，可以在历史记录中查看原始作业运行。
databricks jobs repair-run RUN_ID [flags]
Arguments
RUN_ID
要修复的运行作业运行 ID。 运行不得正在进行。
选项
--json JSON
内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。
--latest-repair-id int
最新修复的 ID。
--no-wait
不要等待到达 TERMINATED 或 SKIPPED 状态
--performance-target PerformanceTarget
无服务器作业上的性能模式。 支持的值：[PERFORMANCE_OPTIMIZED，标准]
--rerun-all-failed-tasks
如果为 true，请修复所有失败的任务。
--rerun-dependent-tasks
如果为 true，请修复依赖于rerun_tasks中任务的所有任务，即使它们以前成功也是如此。
--timeout duration
达到 TERMINATED 或 SKIPPED 状态的最大时间（默认值 20m0s）
databricks 作业重置
覆盖给定作业的所有设置。
databricks jobs update使用命令部分更新作业设置。
databricks jobs reset [flags]
Arguments
None
选项
--json JSON
内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。
databricks 作业立即运行
运行作业并返回触发的运行run_id。
databricks jobs run-now JOB_ID [flags]
Arguments
JOB_ID
要执行的作业的 ID
选项
--idempotency-token string
可选令牌，用于保证作业运行请求的幂等性。
--json JSON
内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。
--no-wait
不要等待到达 TERMINATED 或 SKIPPED 状态
--performance-target PerformanceTarget
无服务器作业上的性能模式。 支持的值：[PERFORMANCE_OPTIMIZED，标准]
--timeout duration
达到 TERMINATED 或 SKIPPED 状态的最大时间（默认值 20m0s）
databricks 作业提交
创建并触发一次性运行。 这样，无需创建作业即可直接提交工作负荷。
databricks jobs submit [flags]
Arguments
None
选项
--budget-policy-id string
要用于此一次性运行的预算策略的用户指定的 ID。
--idempotency-token string
一个可选令牌，可用于保证作业运行请求的幂等性。
--json JSON
内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。
--no-wait
不要等待到达 TERMINATED 或 SKIPPED 状态
--run-name string
可选的运行名称。
--timeout duration
达到 TERMINATED 或 SKIPPED 状态的最大时间（默认值 20m0s）
--timeout-seconds int
可选的超时设置，应用于此作业的每个运行。
databricks 作业更新
添加、更新或删除现有作业的特定设置。 用于 reset 覆盖所有作业设置。
databricks jobs update JOB_ID [flags]
Arguments
JOB_ID
要更新的作业的规范标识符。 此字段为必需字段。
选项
--json JSON
内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。
databricks 作业 get-permission-levels
获取作业权限级别。
databricks jobs get-permission-levels JOB_ID [flags]
Arguments
JOB_ID
要为其获取或管理权限的作业。
选项
databricks 作业获取权限
获取作业的权限。 作业可以从其根对象继承权限。
databricks jobs get-permissions JOB_ID [flags]
Arguments
JOB_ID
要为其获取或管理权限的作业。
选项
databricks 作业集权限
设置作业权限。
设置对象的权限，替换现有权限（如果存在）。 如果未指定任何权限，则删除所有直接权限。 对象可以从其根对象继承权限。
databricks jobs set-permissions JOB_ID [flags]
Arguments
JOB_ID
要为其获取或管理权限的作业。
选项
--json JSON
内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。
databricks 作业更新权限
更新作业的权限。 作业可以从其根对象继承权限。
databricks jobs update-permissions JOB_ID [flags]
Arguments
JOB_ID
要为其获取或管理权限的作业。
选项
--json JSON
内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。
Global flags
--debug
是否启用调试日志记录。
-h 或 --help
显示 Databricks CLI、相关命令组或相关命令的帮助。
--log-file 字符串
一个字符串，表示要将输出日志写入到的文件。 如果未指定此标志，则默认会将输出日志写入到 stderr。
--log-format 格式
日志格式类型或 textjson。 默认值是 text。
--log-level 字符串
一个表示日志格式级别的字符串。 如果未指定，则禁用日志格式级别。
-o, --output 类型
命令输出类型或 textjson。 默认值是 text。
-p, --profile 字符串
用于运行命令的文件中配置文件 ~/.databrickscfg 的名称。 如果未指定此标志，则如果存在，则使用命名 DEFAULT 的配置文件。
--progress-format 格式
显示进度日志的格式： default、 append、 inplace或 json
-t, --target 字符串
如果适用，要使用的捆绑包目标