全部產品
Search
文件中心

OpenSearch:CreateScheduledTask - 建立一個應用的定時任務

更新時間:Nov 24, 2025

建立一個 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 HTTP/1.1

路徑參數

名稱

類型

必填

描述

樣本值

appGroupIdentity

string

應用程式名稱

my_app_group_name

請求參數

名稱

類型

必填

描述

樣本值

body

ScheduledTask

請求體

請求體

欄位類型是否必要樣本值描述
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

result

object

定時任務資訊,參考: ScheduledTask

{}

requestId

string

請求 ID

ABCDEFGH

樣本

正常返回樣本

JSON格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情