创建和更新定时调度任务
更新时间：2025-04-01
接口说明
创建定时调度任务，请求参数参加api文档https://cloud.baidu.com/doc/BES/s/ol6uozs08
请求URI
POST /api/bes/cluster/schedule/create
请求头参数
| 参数名 | 类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| x-Region | String | 是 | 区域 | bd |
请求体参数
请求体字段数据结构说明
| 参数名称 | 必填 | 类型 | 描述 | 示例值 |
|---|---|---|---|---|
| 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 |
| task | 是 | Task | 任务具体参数，不同任务类型配置相应的详细配置 | 参见api文档https://cloud.baidu.com/doc/BES/s/ol6uozs08 |
响应体参数
响应体字段数据结构说明
| 参数名称 | 参数类型 | 描述 | 示例值 |
|---|---|---|---|
| success | Boolean | 请求是否成功 | true |
| status | Integer | 状态码 | 200 |
| result | String | 返回信息 |
请求示例
Plain Text
1POST /api/bes/cluster/schedule/create
2<公共请求头>
3x-Region: bd
4
5
6以创建索引为例
7{
8 "clusterId": "665018667943202816",
9 "schedule": "0 1 0 * * ?",
10 "scheduleName": "CreateIndexApi1",
11 "taskType": "CREATE_INDEX",
12 "task": {
13 "indices": [{
14 "indexPrefix": "apiindex1-",
15 "indexSuffix": "yyyy.MM.dd.HH.mm",
16 "indexInfo": {
17 "settings": {
18 "index": {
19 "number_of_shards": "5",
20 "number_of_replicas": "1"
21 }
22 }
23 }
24 }]
25 }
26}响应示例
Plain Text
1HTTP/1.1 200 OK
2<公共响应头>
3
4{
5 "result" : "result",
6 "success" : true,
7 "status" : 200
8}错误码
请参考通用错误码