CreateScheduledTask - 智能开放搜索 OpenSearch

调试

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

请求头

该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。

请求语法

POST /v4/openapi/app-groups/[appGroupIdentity]/scheduled-tasks HTTP/1.1

请求参数


名称	类型	位置	是否必选	示例值	描述
appGroupIdentity	String	Path	是	my_app_group_name	应用名称

请求体


字段	类型	是否必要	示例值	描述
type	String	是	"wipe"	定时任务类型 wipe 数据清理 fork 导入数据加索引重建 reindex 索引重建 clear 清空数据
cron	String	是	"10 20 * * 1,2,3,4,5"	定时配置参考：ScheduledTask 定时规则
enabled	Boolean	是	true	是否开启定时任务
appStrategy	String	否	delete-idle	创建新版本的策略 delete-idle 已有两个版本，先删除非在线版本，再创建新版本 need-slot 只有一个版本，直接创建新版本
filter	Object	否		数据清理条件
filter.days	Integer	是	7	过期天数获取范围：[7-180]
filter.unit	String	是	"s"	过期时间单位 s 秒 ms 毫秒
filter.field	String	--	"cate_id"	过期字段
runNow	Boolean	--	false	是否立即执行（默认：false）
permanent	Boolean	--	true	是否持久化（默认：true）

返回数据


名称	类型	示例值	描述
requestId	String	ABCDEFGH	请求ID
result	Map	{}	定时任务信息

示例

请求示例

POST /v4/openapi/app-groups/130091942/scheduled-tasks

// 数据清理
{
  "type": "wipe",
  "cron": "0 0 * * 1,2,3,4,5,6,7",
  "enabled": true,
  "filter": {
    "field": "title",
    "days": 30,
    "unit": "s"
  }
}
// 清空数据
{
  "type": "clear",
  "cron": "0 0 * * 1,2,3,4,5,6,7",
  "enabled": true,
  "runNow": true,
  "permanent": false
}
// 导入数据加索引重建
{
  "type": "fork",
  "cron": "0 0 * * 1,2,3,4,5,6,7",
  "enabled": true
}
// 手动索引重建
{
  "type": "reindex",
  "cron": "0 0 * * 1,2,3,4,5,6,7",
  "enabled": true,
  "appStrategy": "need-slot",
  "runNow": true,
  "permanent": false
}

正常返回示例

XML格式

<requestId>0BECF34E-125A-D35F-1E5D-ABB66B11FAB8</requestId>
<result>
    <id>cfd5ebe9-bcdd-11ea-a58d-98039b07e4ec</id>
    <progress>0</progress>
    <status>3</status>
    <lastRanTimestamp/>
    <type>wipe</type>
    <running>false</running>
    <paused>false</paused>
    <finished>false</finished>
    <idle>true</idle>
    <created>1593747144</created>
    <updated>1593747144</updated>
    <cron>0 0 * * 1,2,3,4,5,6,7</cron>
    <enabled>true</enabled>
    <lastScheduledTimestamp/>
    <forkedAppId/>
    <filter>
        <field>title</field>
        <days>30</days>
        <unit>s</unit>
    </filter>
</result>

JSON格式

{
    "requestId": "0BECF34E-125A-D35F-1E5D-ABB66B11FAB8",
    "result": {
        "id": "cfd5ebe9-bcdd-11ea-a58d-98039b07e4ec",
        "progress": 0,
        "status": 3,
        "lastRanTimestamp": "",
        "type": "wipe",
        "running": false,
        "paused": false,
        "finished": false,
        "idle": true,
        "created": 1593747144,
        "updated": 1593747144,
        "cron": "0 0 * * 1,2,3,4,5,6,7",
        "enabled": true,
        "lastScheduledTimestamp": "",
        "forkedAppId": "",
        "filter": {
            "field": "title",
            "days": 30,
            "unit": "s"
        }
    }
}

错误码

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