文档

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

更新时间:

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
opensearch:CreateScheduledTask
  • ScheduledTask
    acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}

请求语法

POST /v4/openapi/app-groups/{appGroupIdentity}/scheduled-tasks

请求参数

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

应用名称

my_app_group_name
bodyScheduledTask

请求体

请求体

字段类型是否必要示例值描述
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"过期字段
runNowBooleanfalse是否立即执行(默认:false)
permanentBooleantrue是否持久化(默认:true)

返回参数

名称类型描述示例值
object
resultobject

定时任务信息,参考: ScheduledTask

{}
requestIdstring

请求 ID

ABCDEFGH

示例

正常返回示例

JSON格式

{
  "result": {},
  "requestId": "ABCDEFGH"
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-05-24OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:body
  • 本页导读 (0)
文档反馈