HTTP/HTTPS
请求协议
APIUSB / 后台接口 / 获取计划任务列表
获取计划任务列表
接口地址:https://api.apiusb.com/api/admin?s=Admin.Task.GetTaskList
接口描述: 获取所有的计划任务
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
access_token | 字符串 | 可选 | 访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口 | ||
page | 整型 | 可选 | 1 | 当前页数 | |
perpage | 整型 | 可选 | 10 | 每页多少条 |
返回字段
返回结果 | 类型 | 说明 |
---|---|---|
ret | 整型 | 状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误 |
data | 对象或混合类型 | 业务数据,由各自接口指定,通常为对象 |
data.total | 整型 | 总条数 |
data.page | 整型 | 当前页数 |
data.perpage | 整型 | 每页条数 |
data.items | 字符串 | 计划任务数据 |
data.items.id | 整型 | id |
data.items.title | 字符串 | 计划任务标题 |
data.items.fire_params | 字符串 | 计划任务接口 |
data.items.api_params | 字符串 | 接口参数 |
data.items.crontab_interval_time | 整型 | 执行间隔 |
data.items.last_fire_time | 整型 | 最后执行时间 |
data.items.enable | 整型 | 是否启动,1启动,0禁止 |
data.items.state | 整型 | 进程状态,0空闲,1运行中,-1异常退出 |
data.items.add_time | 字符串 | 添加时间 |
msg | 字符串 | 提示信息,失败时的错误提示 |
在线测试
参数 | 是否必须 | 值 |
---|---|---|
service | 必须 | |
access_token | 可选 | |
page | 可选 | |
perpage | 可选 |
客户端请求示例
# 暂无示例,可添加示例文件:./src/view/docs/demos/Admin.Task.GetTaskList.json
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | ret=400,客户端参数错误或非法请求 |
404 | 表示接口服务不存在 |
406 | ret=406,access_token令牌校验不通过 |
407 | ret=407,app_key权限不足,或未知应用 |
408 | ret=408,当前用户禁止使用,或用户未登录 |
500 | 表示服务端内部错误 |
本文档生成时间:2024-04-20 03:43:07