- 使用前必读
- 云空间管理接口
- 平台管理接口
- 核心模块
- 驱动管理模块
- 报警模块
- 报警规则管理
- 报警管理
- 根据过滤器查询报警数据
- 保存一条报警数据到数据库
- 确认全部报警数据
- 根据过滤器查询归档报警数据（跳转）.
- 根据ID恢复归档报警信息.
- 根据过滤器查询 报警归档配置数据
- 保存一条 报警归档配置数据到数据库
- 根据id查询 报警归档配置数据
- 根据id及数据替换原有 报警归档配置数据
- 根据id 从数据库删除一条 报警归档配置数据
- 根据id更新 报警归档配置数据
- 根据报警ID字符串数组进行多条报警数据确认/处理
- 查询所有报警描述数据
- 一键归档报警信息.
- 统计报警个数数据.
- 生成根据工作表记录和规则分组的最新100条报警.
- 生成报警数据时间轴数据.
- 根据id查询报警数据
- 根据id及数据替换原有报警数据
- 根据id从数据库删除一条报警数据
- 根据id更新报警数据
- 报警清除管理
- 云空间权限管理模块
- 网络检查模块
- 数据源模块
- 仿真管理模块
- 流程引擎模块
- 流程日志
- 流程实例归档
- 流程测试
- 扩展节点
- 流程实例清除
- 流程任务
- 日志清除
- 流程管理模块
- 前端管理模块
- 报表模块
- 算法管理模块
- 数据库备份模块
- 数据源模块
- 运维管理接口
根据ID更新流程实例归档周期任务配置
PATCH
/engine/instanceArchive/{id}
{
"id": "", // 配置ID
"disabled": false, // 是否禁用，true禁用，false不禁用
"name": "按天归档2", // 配置名称
"flowName": {"$in": ["测试周期1", "测试周期2"]}, // 流程名称
"status": "COMPLETE", // 流程实例执行状态 COMPLETED/FAILED，
"cycle": 1, // 周期
"cycle_type": "day", // 日期单位 "day/week/month/year"
"duration": 1, // 保留天数
"time_config": { // 时间配置
"month": "January", // 月份：月份英文
"weekday": "WED", // 星期：星期英文前三位大写
"day": 1, // 天数：int
"hms": "15:38:00" // 时间
},
"clean_archive": false, // 清除时是否同时清除同配置归档信息
"task_type": "cycle", // 任务类型 "cycle/archiveCycle"
}
请求参数
Path 参数
id
string
周期任务id
Header 参数
x-request-project
string
可选
Authorization
string
Token
默认值:
{{ACCESS_TOKEN}}
Body 参数application/json
clean_archive
boolean
是否清除归档数据
cycle
integer
周期数
cycle_type
string
周期类型
示例值:
year/month/week/day
disabled
boolean
是否禁用
duration
integer
保留天数
flowName
流程
id
string
可选
name
string
计划名称
status
string
状态
task_type
string
可选
time_config
object
周期配置
day
integer
日
hms
string
时分秒
示例值:
10:30:00
month
string
月
示例值:
January/JAN
weekday
string
周
示例值:
Monday/MON
user
object
创建用户
remoteAddr
string
可选
user
string
可选
示例
{
"clean_archive": true,
"cycle": 0,
"cycle_type": "year/month/week/day",
"disabled": true,
"duration": 0,
"flowName": null,
"id": "string",
"name": "string",
"status": "string",
"task_type": "string",
"time_config": {
"day": 0,
"hms": "10:30:00",
"month": "January/JAN",
"weekday": "Monday/MON"
},
"user": {
"remoteAddr": "string",
"user": "string"
}
}示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request PATCH '/engine/instanceArchive/' \
--header 'Authorization: {{ACCESS_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"clean_archive": true,
"cycle": 0,
"cycle_type": "year/month/week/day",
"disabled": true,
"duration": 0,
"flowName": null,
"id": "string",
"name": "string",
"status": "string",
"task_type": "string",
"time_config": {
"day": 0,
"hms": "10:30:00",
"month": "January/JAN",
"weekday": "Monday/MON"
},
"user": {
"remoteAddr": "string",
"user": "string"
}
}'返回响应
🟢200OK
application/json
Body
clean_archive
boolean
是否清除归档数据
cycle
integer
周期数
cycle_type
string
周期类型
示例值:
year/month/week/day
disabled
boolean
是否禁用
duration
integer
保留天数
flowName
流程
id
string
可选
name
string
计划名称
status
string
状态
task_type
string
可选
time_config
object
周期配置
day
integer
日
hms
string
时分秒
示例值:
10:30:00
month
string
月
示例值:
January/JAN
weekday
string
周
示例值:
Monday/MON
user
object
创建用户
remoteAddr
string
可选
user
string
可选
示例
{
"clean_archive": true,
"cycle": 0,
"cycle_type": "year/month/week/day",
"disabled": true,
"duration": 0,
"flowName": null,
"id": "string",
"name": "string",
"status": "string",
"task_type": "string",
"time_config": {
"day": 0,
"hms": "10:30:00",
"month": "January/JAN",
"weekday": "Monday/MON"
},
"user": {
"remoteAddr": "string",
"user": "string"
}
}🟠400请求发生错误
🟠401无效令牌或token过期
🔴500服务器发生错误
修改于 2024-05-14 02:42:02