创建一个 OpenSearch 应用的定时任务。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
opensearch:CreateScheduledTask |
*ScheduledTask
|
无 | 无 |
请求语法
POST /v4/openapi/app-groups/{appGroupIdentity}/scheduled-tasks HTTP/1.1路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| appGroupIdentity |
string |
是 |
应用名称 |
my_app_group_name |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
ScheduledTask |
否 |
请求体 |
请求体
| 字段 | 类型 | 是否必要 | 示例值 | 描述 |
| 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） |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| result |
object |
定时任务信息，参考： ScheduledTask |
{} |
| requestId |
string |
请求 ID |
ABCDEFGH |
示例
正常返回示例
JSON格式
{
"result": {},
"requestId": "ABCDEFGH"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。
该文章对您有帮助吗？