通过

Background Jobs - Run On Demand Table Maintenance

  • 参考
服务:
Lakehouse
API 版本:
v1

注意

此 API 以预览版提供。

运行按需 表维护 作业实例。

所需的委派范围

Lakehouse.Execute.All 或 Item.Execute.All

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

身份 支持
用户 是的
服务主体 和 托管标识 不

接口

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/lakehouses/{lakehouseId}/jobs/instances?jobType={jobType}

URI 参数

名称 在 必需 类型 说明
lakehouseId
 path True

string

uuid

Lakehouse 项 ID。
workspaceId
 path True

string

uuid

工作区 ID。
jobType
 query True

string

TableMaintenance 作业类型。

请求正文

名称 必需 类型 说明
executionData True

TableMaintenanceExecutionData

执行数据以配置 表维护 作业。

响应

名称 类型 说明
202 Accepted

请求已接受，作业执行正在进行中。

标头

  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

常见错误代码：

  • MissingMinimalPermissions - 调用方没有足够的权限来运行作业实例。

  • InvalidJobType - 请求的作业类型无效。

  • TooManyRequestsForJobs - 调用方正在大量运行按需作业请求。

  • ItemNotFound - 找不到请求的项 ID。

示例

Run table maintenance with optimize enabled and vacuum disabled.
Run table maintenance with optimize Z-Order and vacuum enabled for schema enabled lakehouse.
Run table maintenance with optimize Z-Order and vacuum enabled.

Run table maintenance with optimize enabled and vacuum disabled.

示例请求

POST https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/lakehouses/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances?jobType=TableMaintenance

{
  "executionData": {
    "tableName": "table1",
    "optimizeSettings": {}
  }
}

示例响应

状态代码:
202 
Location: https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances/f2d65699-dd22-4889-980c-15226deb0e1b
Retry-After: 60

Run table maintenance with optimize Z-Order and vacuum enabled for schema enabled lakehouse.

示例请求

POST https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/lakehouses/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances?jobType=TableMaintenance

{
  "executionData": {
    "tableName": "table1",
    "schemaName": "dbo",
    "optimizeSettings": {
      "vOrder": true,
      "zOrderBy": [
        "tipAmount"
      ]
    },
    "vacuumSettings": {
      "retentionPeriod": "7:01:00:00"
    }
  }
}

示例响应

状态代码:
202 
Location: https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances/f2d65699-dd22-4889-980c-15226deb0e1b
Retry-After: 60

Run table maintenance with optimize Z-Order and vacuum enabled.

示例请求

POST https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/lakehouses/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances?jobType=TableMaintenance

{
  "executionData": {
    "tableName": "table1",
    "optimizeSettings": {
      "vOrder": true,
      "zOrderBy": [
        "tipAmount"
      ]
    },
    "vacuumSettings": {
      "retentionPeriod": "7:01:00:00"
    }
  }
}

示例响应

状态代码:
202 
Location: https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances/f2d65699-dd22-4889-980c-15226deb0e1b
Retry-After: 60

定义

名称 说明
ErrorRelatedResource

与错误相关的资源详细信息对象。
ErrorResponse

错误响应。
ErrorResponseDetails

错误响应详细信息。
OptimizeSettings

表维护优化设置。
RunOnDemandTableMaintenanceRequest

按需运行 Lakehouse 表维护实例有效负载
TableMaintenanceExecutionData

按需运行 Lakehouse 表维护实例有效负载
VacuumSettings

表维护 真空 设置。

ErrorRelatedResource

Object

与错误相关的资源详细信息对象。

名称 类型 说明
resourceId

string

错误中涉及的资源 ID。
resourceType

string

错误中涉及的资源的类型。

ErrorResponse

Object

错误响应。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
moreDetails

ErrorResponseDetails[]

其他错误详细信息的列表。
relatedResource

ErrorRelatedResource

与错误相关的资源详细信息。
requestId

string

与错误关联的请求的 ID。

ErrorResponseDetails

Object

错误响应详细信息。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
relatedResource

ErrorRelatedResource

与错误相关的资源详细信息。

OptimizeSettings

Object

表维护优化设置。

名称 类型 说明
vOrder

boolean

V 顺序 设置。 True - Enabled、False - Disabled。
zOrderBy

string[]

列名称列表，按 Z 顺序排列数据。 如果未提供，则不会应用 Z 排序。

RunOnDemandTableMaintenanceRequest

Object

按需运行 Lakehouse 表维护实例有效负载

名称 类型 说明
executionData

TableMaintenanceExecutionData

执行数据以配置 表维护 作业。

TableMaintenanceExecutionData

Object

按需运行 Lakehouse 表维护实例有效负载

名称 类型 说明
optimizeSettings

OptimizeSettings

配置维护作业的优化设置。 若要跳过表优化，请将此参数留空。
schemaName

string

在其中创建表的架构的名称。 此属性仅适用于已启用架构的 Lakehouse。 带下划线的 128 个字符字母数字字符串的最大长度。
tableName

string

要在其中运行维护的表的名称。 带下划线的字符字母数字字符串的最大长度为 256。
vacuumSettings

VacuumSettings

配置维护作业的 真空 设置。 若要跳过表清空，请将此参数留空。

VacuumSettings

Object

表维护 真空 设置。

名称 类型 说明
retentionPeriod

string

替代默认保留期。 删除与早于指定保留期的增量表版本关联的未推理文件或数据文件。 此值应遵循 d:hh:mm:ss 模式，其中 d 为天数，hh 是 00 到 23 之间的小时数，mm 是 00 到 59 之间的分钟数，ss 是 00 到 59 之间的秒数。