Update optimizer configuration

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Only the request parameters specific to this API and some common parameters are listed below. For more information, see Common parameters.

Action string required Example value: UpdateOptimizer

Operation to be performed. Value: UpdateOptimizer.

Version string required Example value: 2024-04-30

API version. Value: 2024-04-30.

OptimizerLevel string required Example value: TABLE

Optimizer level

CatalogName string required Sample value: hive

Catalog name

SchemaName string required Sample value: default

Schema/DB name

TableName string required Example value: tbl

Table name

Type string required Example value: COMPACTION

Optimization type

OptimizerConfigurations object required Example value: {}

Optimizer configuration

CompactionConfigurations object[] Optional

Compaction configuration

OptimizerId long Optional Sample value: 1

Optimizer ID

Enabled boolean Optional Example value: true

Whether to enable

ResourceName string Optional Sample value: default

Compute queue name

Options object Optional Example value: {}

Configuration options mapping

ResourceSize long Optional Example value: 0

Resource size

TargetFileSize long Optional Example value: 0

Target file size

CronExpression string Optional Example value: 0 0 * * * ?

Cron expression

CancelRunningTask boolean Optional Example value: false

Whether to cancel running tasks

PartitionFilter string Optional

Partition filter condition

SelfMaintenanceEnabled boolean Optional Example value: false

Whether to enable self-maintenance

LanceUseDaft boolean Optional Example value: false

Whether to use the Daft engine

SnapshotRetentionConfigurations object[] Optional

Snapshot retention configuration

OptimizerId long Optional Example value: 1

Optimizer ID

Enabled boolean Optional Example value: true

Whether to enable

RetentionPolicy string Optional

Retention policy

RetentionDays long Optional Sample value: 0

Retention days

Options object Optional Example value: {}

Configuration options mapping

ResourceName string Optional Example value: default

Compute queue name

ResourceSize long Optional Sample value: 0

Resource size

CronExpression string Optional Example value: 0 0 * * * ?

Cron expression

CancelRunningTask boolean Optional Example value: false

Whether to cancel running tasks

SelfMaintenanceEnabled boolean Optional Example value: false

Whether to enable self-maintenance

PartitionRetentionConfigurations object[] Optional

Partition retention configuration

OptimizerId long Optional Example value: 1

Optimizer ID

Enabled boolean Optional Sample value: true

Enabled

RetentionStrategy string Optional Sample value: CREATE_TIME

Retention strategy

RetentionDays long Optional Example value: 0

Retention days

PnameName string Optional Example value: dt

Partition field name

PnameFormat string Optional Example value: yyyyMMdd

Partition date format

OrphanFileDeletionConfigurations object[] Optional

Orphan file cleanup configuration

OptimizerId long Optional Sample value: 1

Optimizer ID

Enabled boolean Optional Sample value: true

Enabled

RetentionHours long Optional Example value: 0

Retention hours

Options object Optional Example value: {}

Configuration options mapping

ResourceName string Optional Example value: default

Compute queue name

ResourceSize long Optional Example value: 0

Resource size

CronExpression string Optional Example value: 0 0 * * * ?

Cron expression

CancelRunningTask boolean Optional Example value: false

Whether to cancel running tasks

SelfMaintenanceEnabled boolean Optional Example value: false

Whether to enable self-maintenance

Response parameters

Only the response parameters specific to this API are listed below. For more information, see Response structure.

Success boolean Sample value: true

Successful

Request example

Response example

Error codes

The table below lists the error codes related to the business logic of this API. For common error codes, see the Common error codes documentation.

Status code	Error codes	Error message	Note
400	InvalidRequestParam	Invalid request param {}, cause {}	Invalid request parameter {}, reason {}
400	MissingParameter	The required parameter {} is missing.	The required parameter {} is missing.
500	InternalError	The request has failed due to an unknown error.	The request failed due to an unknown error.

Lake AI Service