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

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

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

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

新增任务接口

基本信息

请求参数

Hearder请求参数

Body请求参数

返回参数

调用示例

请求示例

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"
          }
       ]
    ]
}

curl --location 'https://insight.volcengineapi.com/openapi/biz_sub/create_task' \
--header 'X-Insight-Access-Token: ${token}' \
--header 'X-Insight-Biz-Name: ${biz_name}' \
--header 'Content-Type: application/json' \
--data '{
    "rule": [
        "or",
        [
            "in",
            "测试",
            {
                "f": "title"
            }
        ]
    ]
}'

返回示例

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

更新任务接口

基本信息

请求参数

Hearder请求参数

Body请求参数

返回参数

调用示例

请求示例

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序号，必填
}

curl --location 'https://insight.volcengineapi.com/openapi/biz_sub/update_task' \
--header 'X-Insight-Access-Token: ${token}' \
--header 'X-Insight-Biz-Name: ${biz_name}' \
--header 'Content-Type: application/json' \
--data '{
    "task_id": 29,
    "enable_status": 1,
    "rule": [
        "or",
        [
            "in",
            "测试",
            {
                "f": "title"
            }
        ]
    ]
}'

返回示例

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

获取所有任务接口

基本信息

请求参数

Hearder请求参数

返回参数

调用示例

请求示例

REQ:
GET  /openapi/biz_sub/get_task_rules

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

curl --location 'https://insight.volcengineapi.com/openapi/biz_sub/get_task_rules' \
--header 'X-Insight-Access-Token: ${token}' \
--header 'X-Insight-Biz-Name: ${biz_name}'

返回示例

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：仅支持异步队列
        }
    }
}

获取任务状态接口

基本信息

请求参数

Hearder请求参数

Query请求参数

返回参数

调用示例

请求示例

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

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

curl --location 'https://insight.volcengineapi.com/openapi/biz_sub/get_task_rule?task_id=${task_id}' \
--header 'X-Insight-Access-Token: ${token}' \
--header 'X-Insight-Biz-Name: ${biz_name}'

返回示例

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