建立一個 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"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。