任务运维
更新时间:2024-03-01
作业组管理
DeployJobgroup
接口说明
上线已发布的最高版本作业组
原型
POST /v1/project/<projectName>/jobgroup/<jobgroupName>?deploy
请求参数
名称 | 类型 | 位置 | 必须 | 描述 |
---|---|---|---|---|
projectName | String | URL | 是 | 项目空间名称 |
jobgroupName | String | URL | 是 | 作业组名称 |
响应参数
除公共响应参数外,无特殊响应。
错误码
Code | message | HTTP状态码 | 描述 |
---|---|---|---|
AccessDenied | No permission | 403 | 无权限 |
ProjectNotFound | Project is not found. | 404 | 项目空间不存在 |
JobNotFound | Job is not found | 404 | 作业不存在 |
请求示例
POST /v1/project/project1/jobgroup/my-jobgroup?deploy
响应示例
HTTP/1.1 200 OK
Content-Length: 0
Content-Type: application/json
ListJobgroups
接口说明
获取运维中心作业组列表
原型
GET /v1/project/<projectName>/jobgroup?
请求参数
名称 | 类型 | 位置 | 必须 | 描述 |
---|---|---|---|---|
projectName | String | URL | 是 | 项目空间名称 |
owner | String | QueryString | 否 | 责任人搜索项 |
deployer | String | QueryString | 否 | 上线人搜索项 |
publisher | String | QueryString | 否 | 发布人搜索项 |
name | String | QueryString | 否 | 作业组名称(唯一id串)搜索项 |
sourceName | String | QueryString | 否 | 作业组展示名称搜索项 |
status | String | QueryString | 否 | 任务状态过滤项(ALL, PUBLISHED(已发布), DEPLOYED(已上线), DEPLOYED_NEWVERSION(已上线有新版本)),默认 ALL |
pageNo | Integer | QueryString | 是 | 页码,默认:1,若为-1,则不分页 |
pageSize | Integer | QueryString | 是 | 当前页最大显示数量,默认:10,若为-1,则不分页。 |
orderBy | String | QueryString | 否 | 排序字段 |
order | String | QueryString | 否 | 排序方式,枚举值{asc, desc},默认desc |
响应参数
名称 | 类型 | 描述 |
---|---|---|
jobs | List<JobObj> | 作业组描述对象 列表 |
pageNo | Integer | 页码 |
pageSize | Integer | 当前页最大显示数量 |
totalCount | Integer | 总数 |
JobObj 对象定义
名称 | 类型 | 描述 |
---|---|---|
name | String | 作业组名称(唯一 id 串) |
sourceName | String | 作业组展示名称 |
status | String | 作业组状态 |
newestVersion | Integer | 最新版本 |
onlineVersion | Integer | 上线版本 |
nodeCount | Integer | 作业组中节点数量 |
owner | String | 责任人 |
deployer | String | 上线人 |
publisher | String | 发布人 |
publishTime | DateTime | 发布时间,格式: yyyy-MM-ddTHH:mm:ssZ |
deployTime | DateTime | 上线时间,格式: yyyy-MM-ddTHH:mm:ssZ |
isAlarmed | Boolean | 是否配置告警 |
isScheduled | Boolean | 是否配置调度 |
isRunning | Boolean | 是否存在正在运行的实例 |
错误码
Code | message | HTTP状态码 | 描述 |
---|---|---|---|
AccessDenied | No permission | 403 | 无权限 |
请求示例
GET /v1/project/project1/jobgroup?status=DEPLOYED&pageNo=1&pageSize=10
响应示例
HTTP/1.1 200 OK
Content-Length: xxxx
Content-Type: application/json
{
"jobs":[
{
"name":"testJobgroup-00",
"sourceName":"testJobgroup",
"status":"DEPLOYED",
"nodeCount":10,
"publishTime":"2020-01-01T00:00:00Z",
"deployTime":"2020-01-01T00:00:00Z",
"owner":"project1",
"publisher":"user1",
"deployer":"user1",
"isRunning":false,
"isAlarmed":false,
"isScheduled":false,
"newestVersion":1,
"onlineVersion":1
}
],
"totalCount":1,
"pageNo":1,
"pageSize":10
}
DeleteJobgroup
接口说明
删除运维中心作业组
原型
DELETE /v1/project/<projectName>/jobgroup/<jobgroupName>
请求参数
名称 | 类型 | 位置 | 必须 | 描述 |
---|---|---|---|---|
projectName | String | URL | 是 | 项目空间名称 |
jobgroupName | String | URL | 是 | 作业组名称 |
响应参数
除公共响应参数外,无特殊响应。
错误码
Code | message | HTTP状态码 | 描述 |
---|---|---|---|
AccessDenied | No permission | 403 | 无权限 |
ProjectNotFound | Project is not found. | 404 | 项目空间不存在 |
请求示例
DELETE /v1/project/project1/jobgroup/my-jobgroup
响应示例
HTTP/1.1 200 OK
Content-Length: 0
HTTP/1.1 403 NOTPERMISSION
Content-Length: xxx
Content-Type: application/json
{
"code":"AccessDenied",
"message":"No Permission to access project p1",
"requestId":" 81d0b05f-5ad4-1f22-8068-d5c9de60a1d7"
}
KillJobgroupExecution
接口说明
停止正在执行的作业组实例
原型
POST /v1/project/<projectName>/jobgroup/<jobgroupName>/execution/<execId>?kill
请求参数
名称 | 类型 | 位置 | 必须 | 描述 |
---|---|---|---|---|
projectName | String | URL | 是 | 项目空间名称 |
jobgroupName | String | URL | 是 | 作业组名称 |
execId | Integer | URL | 是 | 实例 ID |
响应参数
除公共参数外,无特殊响应参数
错误码
Code | message | HTTP状态码 | 描述 |
---|---|---|---|
AccessDenied | No permission | 403 | 无权限 |
ProjectNotFound | Project is not found. | 404 | 项目空间不存在 |
JobNotFound | Job{0} is not found | 404 | 作业{0}不存在 |
ExecutionNotFound | Execution {0} is not found. | 404 | 实例 {0} 不存在。 |
请求示例
POST /v1/project/project1/jobgroup/my-jobgroup-00/execution/302?kill
响应示例
HTTP/1.1 200 OK
Content-Length: 0
Content-Type: application/json