You need to enable JavaScript to run this app.
导航

实时任务接口

最近更新时间2024.04.18 19:04:27

首次发布时间2024.01.11 10:56:24

本文档介绍内容洞察【实时订阅任务】的配置接口及任务管理接口

概述

内容洞察支持客户按照业务需求,通过【实时订阅任务】的形式,配置数据订阅规则。客户侧可调用任务管理相关接口,配置订阅任务规则。

  • 【实时任务】:即对于新发文实时匹配的任务规则,若新发文符合任务规则,则会实时推送给下游。

备注:
订阅任务配置的规则说明,详见:订阅任务配置
接口调用前置操作,详见:调用指南
实时任务创建完成后,可参考数据消费接口 中的实时数据消费进行数据消费


请求接口

新增任务接口

基本信息

名称内容
接口地址/openapi/biz_sub/create_task
请求方式POST
是否需要鉴权

请求参数

Hearder请求参数

字段类型是否必填说明
X-Insight-Biz-Namestring业务名称 -> 即火山账号ID
X-Insight-Access-TokenstringAPI访问凭证access_token
Content-Typestring'application/json'

Body请求参数

字段类型是否必填说明
rulejson按照订阅任务配置 配置

sync_mode

bool

任务是否支持同步队列消费,默认是false,仅支持现有的异步消费。若填true则该任务命中的数据可同时在同步队列(消费接口入参sync_only=true)和异步队列消费。
默认不可选,需要与洞察产品沟通后开通。

返回参数

字段类型说明
statusint0为成功
messagestring返回错误信息
datatask_idint返回新增的任务的task_id序号

调用示例

请求示例

REQ:
POST  /openapi/biz_sub/create_task

header:
X-Insight-Biz-Name: $biz_name
X-Insight-Access-Token: $token
Content-Type: application/json

Body:
{
    "rule": [
        "or",  
        [
          "in",
          "测试",
          {
             "f":"title"
          }
       ] // 根据第一节的规则配置的格式配置
    ]
}

返回示例

RESP:
{
    "status": 0,
    "message": "succeed",
    "data": {
        "task_id": 1 // 返回新增的任务的task_id序号
    }
}

说明

  • 实时任务的创建上限:50个

更新任务接口

基本信息

名称内容
接口地址/openapi/biz_sub/update_task
请求方式POST
是否需要鉴权

请求参数

Hearder请求参数

字段类型是否必填说明
X-Insight-Biz-Namestring业务名称 -> 即火山账号ID
X-Insight-Access-TokenstringAPI访问凭证access_token
Content-Typestring'application/json'

Body请求参数

字段类型是否必填说明
rulejson按照订阅任务配置 配置
enable_statusint任务开启状态,1是开启,0是关闭
task_idint更改的任务id序号,必填

sync_mode

bool

任务是否支持同步队列消费,默认是false,仅支持现有的异步消费。若填true则该任务命中的数据可同时在同步队列(消费接口入参sync_mode=true)和异步队列消费。
默认不可选,需要与洞察产品沟通后开通。

返回参数

字段类型说明
statusint0为成功
messagestring返回错误信息
datatask_iddict返回更改的任务id序号
task_idenable_statusint返回更改的任务开启状态,1是开启,0是关闭

调用示例

请求示例

REQ:
POST  /openapi/biz_sub/update_task

header:
X-Insight-Biz-Name: $biz_name
X-Insight-Access-Token: $token
Content-Type: application/json

Body:
{
    "rule": [  
        "or",  
        [
          "in",
          "测试",
          {
             "f":"title"
          }
       ] // 根据第一节的规则配置的格式配置
    ],
    "enable_status": 1, // 任务开启状态,1是开启,0是关闭
    "task_id": 3 // 更改的任务id序号,必填
}

返回示例

RESP:
{
    "status": 0,
    "message": "succeed",
    "data": {
        "task_id": 3, // 返回更改的任务id序号
        "enable_status": 1, // 返回更改的任务开启状态,1是开启,0是关闭
    }
}

获取所有任务接口

基本信息

名称内容
接口地址/openapi/biz_sub/get_task_rules
请求方式GET
是否需要鉴权

请求参数

Hearder请求参数

字段类型是否必填说明
X-Insight-Biz-Namestring业务名称 -> 即火山账号ID
X-Insight-Access-TokenstringAPI访问凭证access_token

返回参数

字段类型说明
statusint0为成功
messagestring返回错误信息

data

0(key是int类型的task_id)

enable_status

dict

1:开启,0:关闭

ruleintrule的json dump str
sync_modebool任务是否支持同步队列消费,默认是false

调用示例

请求示例

REQ:
GET  /openapi/biz_sub/get_task_rules

header:
X-Insight-Biz-Name: $biz_name
X-Insight-Access-Token: $token

返回示例

RESP:
```json
RESP:
{
    "status": 0,
    "message": "succeed",
    "data": {
        0: {
           "enable_status": 1, // enable_status 1:开启,0:关闭
           "rule": "{'and',[],[]}" // rule的json dump str
           "sync_mode": false // ture:支持同步队列,false:仅支持异步队列
        }, // Key: task_id序号,自增,
        1: {
           "enable_status": 0, // enable_status 1:开启,0:关闭
           "rule": "{'and',[],[]}" // rule的json dump str
           "sync_mode": false // ture:支持同步队列,false:仅支持异步队列
        }
    }
}

获取任务状态接口

基本信息

名称内容
接口地址/openapi/biz_sub/get_task_rule?task_id=$TASK_ID
请求方式GET
是否需要鉴权

请求参数

Hearder请求参数

字段类型是否必填说明
X-Insight-Biz-Namestring业务名称 -> 即火山账号ID
X-Insight-Access-TokenstringAPI访问凭证access_token

Query请求参数

字段类型是否必填说明
task_idint想要获取的任务id的规则

返回参数

字段类型说明
statusint0为成功
messagestring返回错误信息

data

enable_status

int

1:开启,0:关闭

rulestringrule的json dump str
sync_modebool任务是否支持同步队列消费,默认是false

调用示例

请求示例

REQ:
GET /openapi/biz_sub/get_task_rule?task_id=$TASK_ID

header:
X-Insight-Biz-Name: $biz_name
X-Insight-Access-Token: $token

返回示例

RESP:
{
    "status": 0,
    "message": "succeed",
    "data": {
        "enable_status": 1, // enable_status 1:开启,0:关闭
        "rule": "{'add',[],[]}" // rule的json dump str
        "sync_mode": false // ture:支持同步队列,false:仅支持异步队列
    }
}