功能描述

查询某个业务下所有的周期任务

请求参数

通用参数

字段 类型 必选 描述
bk_app_code string 是 应用ID
bk_app_secret string 是 安全密钥(应用 TOKEN)，可以通过 蓝鲸智云开发者中心 -> 点击应用ID -> 基本信息 获取
bk_token string 否 当前用户登录态，bk_token与bk_username必须一个有效，bk_token可以通过Cookie获取
bk_username string 否 当前用户用户名，应用免登录态验证白名单中的应用，用此字段指定当前用户

接口参数

字段 类型 必选 描述
bk_biz_id string 是 任务所属业务ID
scope string 否 bk_biz_id 检索的作用域。默认为 cmdb_biz，此时检索的是绑定的 CMDB 业务 ID 为 bk_biz_id 的项目；当值为 project 时则检索项目 ID 为 bk_biz_id 的项目

请求参数示例

  1. {
  2.     "bk_app_code": "esb_test",
  3.     "bk_app_secret": "xxx",
  4.     "bk_token": "xxx",
  5.     "bk_biz_id": "2"
  6. }

返回结果示例

  1. {
  2.     "data": [
  3.         {
  4.             "cron": "*/1 15 * * * (m/h/d/dM/MY)",
  5.             "total_run_count": 1,
  6.             "name": "from api 3",
  7.             "creator": "admin",
  8.             "last_run_at": "2018-11-28 15:57:01 +0900",
  9.             "enabled": false,
  10.             "id": 11,
  11.             "template_id": "2"
  12.         },
  13.         {
  14.             "cron": "1,2,3-19/2 2 3 4 5 (m/h/d/dM/MY)",
  15.             "total_run_count": 0,
  16.             "name": "from api 1",
  17.             "creator": "admin",
  18.             "last_run_at": "",
  19.             "enabled": false,
  20.             "id": 6,
  21.             "template_id": "2"
  22.         },
  23.         {
  24.             "cron": "*/5 * * * * (m/h/d/dM/MY)",
  25.             "total_run_count": 0,
  26.             "name": "定时",
  27.             "creator": "admin",
  28.             "last_run_at": "",
  29.             "enabled": false,
  30.             "id": 4,
  31.             "template_id": "2"
  32.         }
  33.     ],
  34.     "result": true
  35. }

返回结果参数说明

名称 类型 说明
result bool true/false 操作是否成功
data dict result=true 时成功数据，详细信息请见下面说明
message string result=false 时错误信息

data

名称 类型 说明
cron string 周期调度表达式
total_run_count int 周期任务运行次数
name string 周期任务名
creator string 创建者
last_run_at string 上次运行时间
enabled bool 是否激活
id int 周期任务ID
template_id string 用于创建该任务的模板ID