ListScheduledTasks_定时任务_管控API参考_开发指南

描述

获取 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	总条数

示例

请求示例

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

返回示例

正确返回

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "totalCount": 1,
  "result": [
    {
      "id": "2f12c585-5873-11ea-974a-7cd30ad3e268",
      "progress": 0,
      "status": 3,
      "lastRanTimestamp": null,
      "type": "wipe",
      "running": false,
      "paused": false,
      "finished": false,
      "idle": true,
      "created": 1582706232,
      "updated": 1582706232,
      "cron": "0 0 * * 1,2,3,4,5,6,7",
      "enabled": true,
      "appId": null,
      "appGroupId": "110091051",
      "ownerId": "2656",
      "lastScheduledTimestamp": null,
      "forkedAppId": "",
      "appGroup": {
        "id": "110091051"
      },
      "owner": {
        "id": "2656"
      },
      "filter": {
        "field": "ctime",
        "days": 30,
        "unit": "s"
      }
    }
  ]
}

错误返回
参考：响应结构