CreateScheduledTask - 创建一个应用的定时任务

创建一个 OpensSearch 应用的定时任务。

接口说明


调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
appGroupIdentitystring

应用名称

my_app_group_name

请求体

字段类型是否必要示例值描述
typeString"wipe"定时任务类型
- wipe 数据清理
- fork 导入数据加索引重建
- reindex 索引重建
- clear 清空数据
cronString"10 20 * * 1,2,3,4,5"定时配置
参考:ScheduledTask 定时规则
enabledBooleantrue是否开启定时任务
appStrategyStringdelete-idle创建新版本的策略
- delete-idle 已有两个版本,先删除非在线版本,再创建新版本
- need-slot 只有一个版本,直接创建新版本
filterObject数据清理条件
filter.daysInteger7过期天数
获取范围:[7-180]
filter.unitString"s"过期时间单位
- s 秒
- ms 毫秒
filter.fieldString--"cate_id"过期字段
runNowBoolean--false是否立即执行(默认:false)
permanentBoolean--true是否持久化(默认:true)

返回参数

名称类型描述示例值
object
resultobject

定时任务信息,参考:ScheduledTask

requestIdstring

请求ID

ABCDEFGH

示例

正常返回示例

JSON格式

{
  "result": {
    "test": "test",
    "test2": 1
  },
  "requestId": "ABCDEFGH"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
阿里云首页 智能开放搜索 OpenSearch 相关技术圈