查看定时调度任务
更新时间：2025-08-20
请求URI
POST /api/bes/cluster/schedule/list
请求头参数
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| x-Region | String | 是 | 区域 | bd |
请求体参数
请求体字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| clusterId | String | 是 | 集群ID，超过规定18位会返回500错误 | 570900694777860096 |
响应体参数
| 参数名称 | 参数类型 | 描述 | 示例值 |
|---|---|---|---|
| success | boolean | 请求是否成功 | true |
| status | integer | 状态码 | 200 |
| result | Result | 返回信息 |
Result字段数据结构说明
| 参数名称 | 参数类型 | 描述 | 示例值 |
|---|---|---|---|
| clusterId | String | 集群ID | 570900694777860096 |
| schedule | String | 任务的定期或周期调度 | 0 0/5 * * ?：每5min执行一次任务，0 30 1 * ?：每天的1:30am执行任务 |
| scheduleName | String | 定时调度任务名称，支持字母(a-z及A-Z)和数字(0-9),长度6~24个字符 | test123 |
| taskType | String | 定时调度任务类型 | CREATE_INDEX |
| taskRunTimes | String | 执行次数 | |
| taskFailTimes | String | 失败次数 | |
| lastExecuteMillis | String | 上次执行时间 | |
| modifiedMillis | String | 修改时间 | |
| scheduleId | String | 任务id | |
| modifiedVersion | String | 修改版本 | |
| status | String | 状态 | |
| task | Task | 任务具体参数 |
请求示例
Plain Text
1POST /api/bes/cluster/schedule/list
2<公共请求头>
3x-Region: bd
4
5
6{
7 "clusterId": "665018667943202816"
8}响应示例
Plain Text
1HTTP/1.1 200 OK
2<公共响应头>
3
4{
5 "success": true,
6 "status": 200,
7 "result": {
8 "schedules": [{
9 "schedule": "0 4 0 * * ?",
10 "scheduleName": "IndexColdApi100",
11 "taskType": "MIGRATE_COLD",
12 "task": {
13 "indexPatterns": ["apiindex*"],
14 "minIndexAge": "48h",
15 "coldStorage": "BOS"
16 },
17 "taskRunTimes": 0,
18 "taskFailTimes": 0,
19 "lastExecuteMillis": 0,
20 "modifiedMillis": 1658912883143,
21 "modifiedVersion": 1,
22 "status": "RUNNING"
23 }, {
24 "schedule": "0 7 0 * * ?",
25 "scheduleName": "SettingApi100",
26 "taskType": "CLUSTER_SETTINGS",
27 "task": {
28 "persistent": {
29 "bpack.migrate.max_bytes_per_sec": "40MB"
30 },
31 "transient": {}
32 },
33 "taskRunTimes": 0,
34 "taskFailTimes": 0,
35 "lastExecuteMillis": 0,
36 "modifiedMillis": 1658914322424,
37 "modifiedVersion": 1,
38 "status": "RUNNING"
39 }, {
40 "schedule": "0 5 0 * * ?",
41 "scheduleName": "RolloverApi100",
42 "taskType": "ROLLOVER",
43 "task": {
44 "alias": ["apiindex1"],
45 "maxSize": "10kb",
46 "maxDocs": 100000,
47 "maxAge": "100h"
48 },
49 "taskRunTimes": 0,
50 "taskFailTimes": 0,
51 "lastExecuteMillis": 0,
52 "modifiedMillis": 1658914129397,
53 "modifiedVersion": 1,
54 "status": "RUNNING"
55 }, {
56 "schedule": "0 3 0 * * ?",
57 "scheduleName": "ForcemergeApi100",
58 "taskType": "FORCEMERGE",
59 "task": {
60 "indexPatterns": ["apiindex*"],
61 "minIndexAge": "100h",
62 "maxNumSegments": 1
63 },
64 "taskRunTimes": 0,
65 "taskFailTimes": 0,
66 "lastExecuteMillis": 0,
67 "modifiedMillis": 1658911986313,
68 "modifiedVersion": 1,
69 "status": "RUNNING"
70 }, {
71 "schedule": "0 8 0 * * ?",
72 "scheduleName": "BackupApi100",
73 "taskType": "SNAPSHOT",
74 "task": {
75 "repository": "esRes",
76 "snapshot": "snaptest",
77 "retention": {
78 "expireAfter": "90d",
79 "minCount": "0",
80 "maxCount": "2147483647"
81 },
82 "taskParams": {
83 "indices": "apiIndex1"
84 }
85 },
86 "taskRunTimes": 0,
87 "taskFailTimes": 0,
88 "lastExecuteMillis": 0,
89 "modifiedMillis": 1658914384638,
90 "modifiedVersion": 1,
91 "status": "RUNNING"
92 }, {
93 "schedule": "0 2 0 * * ?",
94 "scheduleName": "DelIndexApi100",
95 "taskType": "DELETE",
96 "task": {
97 "indexPatterns": ["apiindex*"],
98 "minIndexAge": "24h"
99 },
100 "taskRunTimes": 0,
101 "taskFailTimes": 0,
102 "lastExecuteMillis": 0,
103 "modifiedMillis": 1658911939815,
104 "modifiedVersion": 1,
105 "status": "RUNNING"
106 }, {
107 "schedule": "0 6 0 * * ?",
108 "scheduleName": "StoreLimitApi100",
109 "taskType": "INDEX_STORE_MANAGER",
110 "task": {
111 "indexPatterns": ["apiindex*"],
112 "maxSize": "100gb"
113 },
114 "taskRunTimes": 0,
115 "taskFailTimes": 0,
116 "lastExecuteMillis": 0,
117 "modifiedMillis": 1658915010970,
118 "modifiedVersion": 1,
119 "status": "RUNNING"
120 }, {
121 "schedule": "0 1 0 * * ?",
122 "scheduleName": "CreateIndexApi100",
123 "taskType": "CREATE_INDEX",
124 "task": {
125 "indices": [{
126 "indexPrefix": "apiindex1-",
127 "indexSuffix": "yyyy.MM.dd.HH.mm",
128 "indexInfo": {
129 "settings": {
130 "index": {
131 "number_of_shards": "1",
132 "number_of_replicas": "1"
133 }
134 }
135 }
136 }]
137 },
138 "taskRunTimes": 0,
139 "taskFailTimes": 0,
140 "lastExecuteMillis": 0,
141 "modifiedMillis": 1658911611317,
142 "modifiedVersion": 1,
143 "status": "RUNNING"
144 }]
145 }
146}错误码
请参考通用错误码