SubmitLanceTableCleanupTask

更新时间:
复制 MD 格式

提交 Lance 历史版本清理任务。Body 必须非空,并提供至少一个有效清理条件。

权限说明

API

Action

说明

SubmitLanceTableCleanupTask

oss:PutTableMaintenanceConfiguration

提交历史版本清理任务。

请求语法

POST /lance/oss/v1/table/{id}/cleanup HTTP/1.1
Host: {tableBucketHost}
Date: GMT Date
Authorization: SignatureValue
Content-Type: application/json

{
  "retain_versions": 2,
  "delete_unverified": false,
  "error_if_tagged_old_versions": false
}

请求参数

接口的公共约定(访问地址、表标识、请求与响应头、权限、异步提交与额度、任务状态、错误码)请参见 Lance 表维护。

参数

位置

是否必须

描述

older_than

body

条件必填

string。默认值空字符串。历史版本清理的时间条件。提交时只检查是否非空,格式要求见下文组合约束。

retain_versions

body

条件必填

int64。默认值 0。保留版本数量参数,不能为负;未提供非空 older_than 时必须大于 0。

delete_unverified

body

否

boolean。默认值 false。当前仅允许 false;true 返回 400 / InvalidInput / 13。

error_if_tagged_old_versions

body

否

boolean。默认值 false。当前仅允许 false;true 返回 400 / InvalidInput / 13。

组合约束:older_than 非空,或 retain_versions > 0,至少满足一个;两者也可以同时提供。

older_than 格式

older_than 支持单位:一周写 7d 或 168h,不支持 1w;支持 0d、007d;不支持小数、负数、复合单位、大写或空格(如 1.5d、-7d、1h30m、7D、7 d)。

单位

含义

示例

d

天

7d

h

小时

168h

m

分钟

30m

s

秒

45s

提交校验示例:

请求 Body

提交结果

{"retain_versions":2}

接受,补齐其余默认值

{"retain_versions":0}

拒绝,缺少清理条件

{} 或空 Body

拒绝

{"retain_versions":-1}

拒绝

{"retain_versions":2,"delete_unverified":true}

拒绝

{"retain_versions":2,"error_if_tagged_old_versions":true}

拒绝

响应

HTTP/1.1 200 OK
Content-Type: application/json
x-oss-table-id: {table_id}

{
  "task_id": "123xxxxxxxxxxxxxxxxxxx",
  "status": "submitted"
}

查询时对应 task_type=lance_cleanup。

错误码

本接口使用 Lance 统一 JSON 错误格式,通用错误码与错误响应结构见公共约定中的 错误响应格式。