作业设置¶
说明¶
- 管理作业存放的目录、作业超时时间、作业无响应时间和作业保存天数
1、作业列表、新增作业、批量删除作业 API¶
请求方式: GET(查询) POST(新增) DELETE(批量删除)
请求地址: /api/system/system/jobsettings/
Content-Type:
新增数据的时候需要指定Content-Type,以下对Content-Type进行说明:
application/x-www-form-urlencoded —— 表示通过表单方式提交
application/json —— 表示传入数据为json格式字符串
输入参数(新增):
参数 | 数据类型 | 是否必须 | 说明 |
workspace | string | 是 | 工作目录 |
job_timeout | int | 是 | 作业超时时间(秒):0表示不超时 |
idle_timeout | int | 是 | 作业无响应时间(秒):0表示不超时 |
keep_days | int | 是 | 日志保存天数(0表示不清理) |
project_id | int | 否 | 项目ID |
输出参数:
参数 | 数据类型 | 是否必须 | 说明 |
id | int | 是 | 作业 id |
workspace | string | 是 | 工作目录 |
job_timeout | int | 是 | 作业超时时间(秒):0表示不超时 |
idle_timeout | int | 是 | 作业无响应时间(秒):0表示不超时 |
keep_days | int | 是 | 日志保存天数(0表示不清理) |
project_id | int | 否 | 项目ID |
批量删除参数:
参数 | 数据类型 | 是否必须 | 说明 |
pk | string | 与pk[]不能都为空 | 主键,多个主键用半角逗号隔开。通过http body传入 |
pk[] | array | 与pk不能都为空 | 主键数组。通过http body传入 |
排序:
参数 | 数据类型 | 是否必须 | 说明 |
ordering | string | 否 |
|
GET返回数据例子:
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": 4,
"workspace": "/tmp",
"job_timeout": 0,
"idle_timeout": 30,
"keep_days": 1,
"project_id": 3
}
]
}
新增作业返回数据例子:
{
"id": 4,
"workspace": "/tmp",
"job_timeout": 0,
"idle_timeout": 30,
"keep_days": 1,
"project_id": 3
}
2、获取单个作业,修改作业、删除作业 API¶
请求方式: GET(查询) PUT(修改) PATCH(修改) DELETE(删除)
请求地址: /api/system/system/jobsettings/4/
请求地址中4为作业的id
输入/输出参数: 见章节1中输入和输出参数说明,修改数据时输入参数均为非必须
返回数据例子:
{
"id": 4,
"workspace": "/tmp",
"job_timeout": 0,
"idle_timeout": 30,
"keep_days": 1,
"project_id": 3
}