docs/apidoc/zh_hans/set_periodic_task_enabled.md · dlts/bk-sops - Gitee.com

forked from 腾讯蓝鲸智云 / bk-sops

加入 Gitee

与超过 1200万开发者一起发现、参与优秀开源项目，私有仓库也完全免费：）

克隆/下载

set_periodic_task_enabled.md 1.98 KB

### 功能描述

设置某个周期任务是否激活

### 请求参数

#### 通用参数

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

#### 接口参数

| 字段          |  类型       | 必选   |  描述             |
|---------------|------------|--------|------------------|
|   task_id    |   string     |   是   |  周期任务ID |
|   bk_biz_id    |   string     |   是   |  任务所属业务ID |
|   enabled    |   bool     |   否   | 该周期任务是否激活，不传则为 false |

### 请求参数示例

```
{
    "bk_app_code": "esb_test",
    "bk_app_secret": "xxx",
    "bk_token": "xxx",
    "bk_biz_id": "2",
    "task_id": "8",
    "enabled": false
}
```

### 返回结果示例

```
{
    "data": {
        "enabled": false
    },
    "result": true
}
```

### 返回结果参数说明

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

#### data

|   名称   |  类型  |           说明             |
| ------------ | ---------- | ------------------------------ |
|  enabled      |    bool    |      当前周期任务是否已经激活    |

一键复制原始数据按行查看历史

提交于 2019-06-21 20:31 . minor: 优化本地文档格式 #391

功能描述

设置某个周期任务是否激活

请求参数

通用参数

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

接口参数

字段	类型	必选	描述
task_id	string	是	周期任务ID
bk_biz_id	string	是	任务所属业务ID
enabled	bool	否	该周期任务是否激活，不传则为 false

请求参数示例

{
    "bk_app_code": "esb_test",
    "bk_app_secret": "xxx",
    "bk_token": "xxx",
    "bk_biz_id": "2",
    "task_id": "8",
    "enabled": false
}

返回结果示例

{
    "data": {
        "enabled": false
    },
    "result": true
}

返回结果参数说明

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

data

名称	类型	说明
enabled	bool	当前周期任务是否已经激活

Python

1

https://gitee.com/dlts85/bk-sops.git

git@gitee.com:dlts85/bk-sops.git

dlts85

bk-sops

bk-sops

master