全部产品
云市场
云游戏

ListScheduledTasks

更新时间:2020-07-17 18:02:07

描述

获取 opensearch 应用定时任务列表

方法

GET

URI

/v4/openapi/app-groups/[appGroupIdentity]/scheduled-tasks

请求参数

路径参数

字段 类型 是否必要 示例值 描述
appGroupIdentity String “my_app_group_name” 应用名称

查询参数

字段 类型 是否必要 示例值 描述
id String “2f12c585-5873-11ea-974a-7cd30ad3e268” 任务ID
type String “wipe” 定时任务类型
- wipe 数据清理
- fork 索引重建
- check-status 检查应用状态
- index 索引重建
- app
enabled Boolean true 是否已开启定时任务
updated Integer 1582706232 定时任务的更新时间戳
pageNumber Integer 1 页码,默认 pageNumber = 1
pageSize Integer 10 每页返回数目,默认 pageSize = 10

返回参数

字段 类型 描述
requestId String 请求ID
result[] Object 定时任务信息
参考:ScheduledTask
totalCount Integer 总条数

示例

请求示例

  1. GET /v4/openapi/app-groups/110091051/scheduled-tasks?type=wipe

返回示例

正确返回

  1. {
  2. "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  3. "totalCount": 1,
  4. "result": [
  5. {
  6. "id": "2f12c585-5873-11ea-974a-7cd30ad3e268",
  7. "progress": 0,
  8. "status": 3,
  9. "lastRanTimestamp": null,
  10. "type": "wipe",
  11. "running": false,
  12. "paused": false,
  13. "finished": false,
  14. "idle": true,
  15. "created": 1582706232,
  16. "updated": 1582706232,
  17. "cron": "0 0 * * 1,2,3,4,5,6,7",
  18. "enabled": true,
  19. "appId": null,
  20. "appGroupId": "110091051",
  21. "ownerId": "2656",
  22. "lastScheduledTimestamp": null,
  23. "forkedAppId": "",
  24. "appGroup": {
  25. "id": "110091051"
  26. },
  27. "owner": {
  28. "id": "2656"
  29. },
  30. "filter": {
  31. "field": "ctime",
  32. "days": 30,
  33. "unit": "s"
  34. }
  35. }
  36. ]
  37. }


错误返回
参考:响应结构