创建任务执行
接口描述
可以通过如下两种方式创建任务执行:
引用一个已存在的模板(参考请求示例1)
在创建执行时动态创建一个模板(参考请求示例2)
请求结构
method:POST
URL:/api/logic/oos/v2/execution
请求参数
名称
类型
描述
是否必须
参数位置
execution
Execution
任务执行
是
RequestBody参数
请求示例1
POST /api/logic/oos/v2 /execution
{
"template" : {
"ref" : "tpl-tKXV1J**" ,
"name" : "test_oos_template" ,
"linear" : true
} ,
"properties" : {
"strParam" : "testParam"
} ,
"description" : "这是一段描述" ,
"tags" : [
{
"tagKey" : "key2" ,
"tagValue" : "value2"
}
]
}
请求示例2
{
"template" : {
"name" : "执行脚本的模板" ,
"linear" : true ,
"operators" : [
{
"name" : "run_script" ,
"description" : "这是一段描述" ,
"operator" : "BCE::Agent::ExecuteShell" ,
"retries" : 0 ,
"retryInterval" : 60000 ,
"timeout" : 3600000 ,
"properties" : {
"content" : "ls /" ,
"user" : "root" ,
"workDir" : "/tmp" ,
"__workerSelectors__" : [
{
"id" : "3f367371-****-****-****-c27f57798e7e" ,
"shortId" : "i-w1ayJ7**" ,
}
]
}
}
]
}
}
响应示例
{
"success" : true ,
"msg" : "" ,
"code" : 200 ,
"result" : {
"id" : "d-CRpnWZ******"
}
}
查看任务执行
请求结构
method:GET
URL:/api/logic/oos/v2/execution?{Query参数}
请求参数
名称
类型
描述
是否必须
参数位置
id
String
任务执行ID
是
Query参数
请求示例
GET /api/logic/oos/v2 /execution?id=d-lkzdgP******
响应示例
{
"success" : true ,
"msg" : "" ,
"code" : 200 ,
"result" : {
"id" : "d-lkzdgP******" ,
}
}
查询任务执行列表
请求结构
method:POST
URL:/api/logic/oos/v2/execution/list
请求参数
名称
类型
描述
是否必须
参数位置
template
Template
模板信息,如设置则只返回指定模板触发的执行列表
否
RequestBody参数
state
String
执行状态,如设置则只返回指定状态的执行列表,可选值:RUNNING(执行中)、SUCCESS(执行成功)、FAILED(执行失败)、CANCELED(已取消)、PENDING(等待中)
否
RequestBody参数
eventExecutionName
String
报警事件运维名称,如设置则只返回指定报警事件运维触发的执行列表
否
RequestBody参数
cronExecutionName
String
定时运维名称,如设置则只返回指定定时运维触发的执行列表
否
RequestBody参数
startTime
long
执行开始时间,单位:毫秒,默认值为7天前毫秒时间戳
否
RequestBody参数
endTime
long
执行结束时间,单位:毫秒,默认值为当前毫秒时间戳
否
RequestBody参数
sort
String
排序字段,默认为执行开始时间,可选值:startTime,endTime
否
RequestBody参数
ascending
boolean
是否升序,默认false
否
RequestBody参数
pageNo
int
页数,从1开始计数
是
RequestBody参数
pageSize
int
每页展示数量,最大值:100,最小值:1
是
RequestBody参数
请求示例
POST /api/logic/oos/v2 /execution/list
{
"sort" : "startTime" ,
"state" : "SUCCESS" ,
"startTime" : 1719296223700 ,
"endTime" : 1719901023700 ,
"template" : {
"name" : "my_template_123"
} ,
"pageNo" : 1 ,
"pageSize" : 10
}
响应示例
{
"success" : true ,
"msg" : "" ,
"result" : {
"executions" : [
{
"id" : "d-kwE00s******" ,
"template" : {
"name" : "my_template_123" ,
"type" : "INDIVIDUAL" ,
} ,
"parallelism" : 0 ,
"createdTimestamp" : 1719900946278 ,
"updatedTimestamp" : 1719901257454 ,
"finishedTimestamp" : 1719901257454 ,
"state" : "SUCCESS" ,
"reason" : ""
}
] ,
"orderBy" : "startTime" ,
"order" : "desc" ,
"pageNo" : 1 ,
"pageSize" : 10 ,
"totalCount" : 3
}
}