HTTP/HTTPS
请求协议
接口大师 / 后台接口 / 修改计划任务配置
修改计划任务配置
接口地址:http://localhost/public/api/admin.php?s=Admin.Task.EditTaskConfig
接口描述: 更新计划任务
接口参数
| 参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
|---|---|---|---|---|---|
| access_token | 字符串 | 可选 | 访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口 | ||
| id | 整型 | 必须 | - | 计划任务id | |
| title | 字符串 | 可选 | - | 计划任务标题 | |
| task_service | 字符串 | 可选 | - | 计划任务接口, 如App.Task.Demo | |
| api_params | 字符串JSON格式 | 可选 | - | 接口参数,json格式 | |
| crontab_interval_time | 整型 | 可选 | 60 | 最小:10 | 计划任务运行间隔,单位:秒 |
| enable | 布尔型 | 可选 | - | 开关,默认打开 | |
| state | 整型 | 可选 | - | 进程状态,0空闲,1运行中,-1异常退出 |
返回字段
| 返回结果 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误 |
| data | 对象或混合类型 | 业务数据,由各自接口指定,通常为对象 |
| data.isUpdate | bool | 是否更新 |
| data.msg | 字符串 | 更新信息 |
| msg | 字符串 | 提示信息,失败时的错误提示 |
在线测试
| 参数 | 是否必须 | 值 |
|---|---|---|
| service | 必须 | |
| access_token | 可选 | |
| id | 必须 | |
| title | 可选 | |
| task_service | 可选 | |
| api_params | 可选 | |
| crontab_interval_time | 可选 | |
| enable | 可选 | |
| state | 可选 |
客户端请求示例
# 暂无示例,可添加示例文件:./src/view/docs/demos/Admin.Task.EditTaskConfig.json错误列表
| 错误状态码 | 错误描述信息 |
|---|---|
| 400 | ret=400,客户端参数错误或非法请求 |
| 404 | 表示接口服务不存在 |
| 406 | ret=406,access_token令牌校验不通过 |
| 407 | ret=407,app_key权限不足,或未知应用 |
| 408 | ret=408,当前用户禁止使用,或用户未登录 |
| 500 | 表示服务端内部错误 |
本文档生成时间:2021-03-25 15:10:56