全部產品
Search

搜尋本產品

    OpenSearch：CreateScheduledTask

    文件中心

    OpenSearch：CreateScheduledTask

    更新時間：Aug 04, 2026

    建立一個 OpenSearch 應用程式的排程任務。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    opensearch:CreateScheduledTask

    create

    *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 排程規則

    enabledBoolean是true是否啟用排程任務
    appStrategyString否delete-idle建立新版本的策略
    - delete-idle 已有兩個版本，先刪除非線上版本，再建立新版本
    - need-slot 只有一個版本，直接建立新版本




    filterObject否資料清理條件
    filter.daysInteger是7過期天數
    取得範圍：[7-180]

    filter.unitString是"s"過期時間單位
    - s 秒
    - ms 毫秒




    filter.fieldString否"cate_id"過期欄位
    runNowBoolean否false是否立即執行（預設：false）
    permanentBoolean否true是否持久化（預設：true）

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    result

    object

    排程任務資訊，參考： ScheduledTask

    {}
    requestId

    string

    請求 ID。

    ABCDEFGH

    樣本

    正常返回樣本

    JSON格式

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

    錯誤碼

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

    變更歷史

    更多資訊，參考變更詳情。