任务执行(Execution)接口
更新时间:2023-12-20
创建任务执行
接口描述
可以通过如下两种方式创建任务执行:
- 引用一个已存在的模板(参考请求示例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", // BCC长实例id
"shortId": "i-w1ayJ7**", // BCC短实例id
}
]
}
}
]
}
}
响应示例
{
"success":true,
"msg":"",
"code":200,
"result":{
// 任务执行ID
"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******",
// 结构体字段参考附录中的Execution
}
}