v1
latestOpenAPI 3.0.12026-07-26245126202.6 KBSegment
Delete selected segments. An optional 'excludeReplacedSegments' parameter is used to get the list of segments which has not yet been replaced (determined by segment lineage entries) and can be queried from the table. The value is false by default.
List all segments
delete/segments/{tableName}/choose
Path parameters
tableNamestring required
Name of the table
Query parameters
typestring
OFFLINE|REALTIME
excludeReplacedSegmentsboolean
Whether to ignore replaced segments for deletion, which have been replaced specified in the segment lineage entries and cannot be queried from the table, false by default
startTimestampstring required
Start timestamp (inclusive) in milliseconds
endTimestampstring required
End timestamp (exclusive) in milliseconds
excludeOverlappingboolean
Whether to ignore segments that are partially overlapping with the [start, end)for deletion, true by default
retentionstring
Retention period for the table segments (e.g. 12h, 3d); If not set, the retention period will default to the first config that's not null: the table config, then to cluster setting, then '7d'. Using 0d or -1d will instantly delete segments without retention
Response
successful operation