docs/apidoc/zh_hans/query_task_count.md · wangjili/bk-sops

功能描述

查询任务实例分类统计总数

请求参数

通用参数

字段	类型	必选	描述
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
group_by	string	是	分类统计维度，status：按任务状态（未执行、执行中、已完成）统计，category：按照任务类型统计，flow_type：按照流程类型统计，create_method：按照创建方式
conditions	dict	否	任务过滤条件

conditions

字段	类型	描述
template_id	string	创建任务的模板ID
name	string	任务名称
creator	string	创建人
create_time__gte	string	任务创建时间起始时间
create_time__lte	string	任务创建时间截止时间
executor	string	执行人
start_time__gte	string	任务执行时间起始时间
start_time__lte	string	任务执行时间截止时间
is_started	bool	任务是否启动
is_finished	bool	任务是否完成

请求参数示例

{
    "bk_app_code": "esb_test",
    "bk_app_secret": "xxx",
    "bk_token": "xxx",
    "bk_biz_id": "2",
    "conditions": {
        "create_time__lte": "2018-07-12 10:00:00",
        "is_started": true
    },
    "group_by": "flow_type"
}

返回结果示例

{
    "data": {
        "total": 180,
        "groups": [
            {
                "code": "common",
                "name": "默认任务流程",
                "value": 166
            },
            {
                "code": "common_func",
                "name": "职能化任务流程",
                "value": 14
            }
        ]
    },
    "result": true
}

返回结果参数说明

字段	类型	描述
result	bool	true/false 操作是否成功
data	dict	result=true 时返回分类统计信息，详细信息见下面说明
message	string	result=false 时错误信息

data

字段	类型	描述
total	int	按照过滤条件获取的任务总数
groups	list	按照过滤条件分类分类统计详情

data.groups[]

字段	类型	描述
code	string	分类统计类型编码
name	string	分类统计类型名称
value	string	当前分类任务数量

wangjili / bk-sops

功能描述

请求参数

通用参数

接口参数

conditions

请求参数示例

返回结果示例

返回结果参数说明

data

data.groups[]

简介

发行版

贡献者

近期动态

wangjili / bk-sops .gitee-modal { width: 500px !important; }

功能描述

请求参数

通用参数

接口参数

conditions

请求参数示例

返回结果示例

返回结果参数说明

data

data.groups[]

简介

发行版

贡献者

近期动态

搜索帮助

wangjili / bk-sops