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

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

• 【回溯任务】：即对于历史发文批量匹配的任务规则，若历史发文符合任务规则，则会即时批量推送给下游。

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

回溯任务数量预览接口

基本信息

请求参数

Hearder请求参数

Body请求参数

返回参数

调用示例

请求示例

REQ:
GET  /openapi/backtrack/preview_task

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

Body:
{
    "rule": [
        "and",
        [
            "or",
            [
                "or",
                [
                    "in",
                    "测试",
                    {
                        "f": "title"
                    }
                ]
            ]
        ] // 根据第一节的规则配置的格式配置，最大支持三层，限制节点数200以内，规则还不支持related_location
    ]，
    "start_time": "2023-06-01 00:00:00", // 起始时间需要是最近九十天的时间（回溯最早只能支持九十内）
    "end_time": "2023-06-10 00:00:00", // 注意end_time大于start_time
    "de_duplicate": true, // 是否去重，默认去重（去重是指消费过的数据不再回溯）
}

curl --location --request GET 'https://insight.volcengineapi.com/openapi/backtrack/preview_task' \
--header 'X-Insight-Biz-Name: ${biz_name}' \
--header 'X-Insight-Access-Token: ${token}' \
--header 'Content-Type: application/json' \
--data '{
    "rule": [
        "and",
        [
            "in",
            "测试",
            {
                "f": "title"
            }
        ]
    ],
    "start_time": "2024-08-01 00:00:00",
    "end_time": "2024-08-02 00:00:00",
    "de_duplicate": true
}'

返回示例

RESP:
{
    "status": 0,
    "message": "succeed",
    "data": {
        "count": 12324242 // 估计的命中量级
    }
}

回溯任务创建接口

基本信息

请求参数

Hearder请求参数

Body请求参数

返回参数

调用示例

请求示例

REQ:
POST   /openapi/backtrack/create_task

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

Body:
{
    "rule": [
        "and",
        [
            "or",
            [
                "or",
                [
                    "in",
                    "测试",
                    {
                        "f": "title"
                    }
                ]
            ]
        ] // 根据第一节的规则配置的格式配置，最大支持三层，限制节点数200以内，规则还不支持related_location
    ],
    "start_time": "2023-06-01 00:00:00", // 起始时间需要是最近九十天的时间（回溯最早只能支持九十天内）
    "end_time": "2023-06-10 00:00:00", // 注意end_time大于start_time
    "de_duplicate": true, // 是否去重，默认去重
    "limit": 100 // 任务的limit数，回溯到的数据量会小于等于填入的limit数
}

curl --location 'https://insight.volcengineapi.com/openapi/backtrack/create_task' \
--header 'X-Insight-Biz-Name: ${biz_name}' \
--header 'X-Insight-Access-Token: ${token}' \
--header 'Content-Type: application/json' \
--data '{
    "rule": [
        "and",
        [
            "in",
            "测试",
            {
                "f": "title"
            }
        ]
    ],
    "de_duplicate": false,
    "start_time": "2024-05-20 10:32:01",
    "end_time": "2024-05-28 20:00:01"
}'

返回示例

RESP:
{
    "status": 0,
    "message": "succeed",
    "data": {
        "task_id": 0
    }
}

回溯任务状态查询接口

基本信息

请求参数

Hearder请求参数

Query请求参数

返回参数

调用示例

请求示例

REQ:
GET /openapi/backtrack/get_task_info?task_id=0

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

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

**返回示例**

```json
RESP:
{
    "status": 0,
    "message": "succeed",
    "data": {
        "task_status": "running", // 回溯任务状态，running/waiting/finished/failed
        "task_cur_max_offset": 122999, // 目前回溯到的最大offset
        "collector_cur_max_offset": {
            "0": 4,
            "1": 7,
            "10": 4,
            "11": 4,
            "12": 8,
            "13": 5,
            "14": 9,
            "15": 7,
            "16": 8,
            "17": 10,
            "18": 9,
            "19": 3,
            "2": 16,
            "3": 8,
            "4": 8,
            "5": 6,
            "6": 7,
            "7": 10,
            "8": 10,
            "9": 7
        }, // 目前每个collector能回溯到的最大offset，key为collector，value为offset
        "rule": "{\"end_date\":\"2023-06-28\",\"rule\":[\"or\",[\"in\",\"好人\",{\"fl\":[\"title\",\"asr\",\"ocr\"]}],[\"in\",\"火山\",{\"fl\":[\"title\",\"asr\",\"ocr\"]}],[\"in\",\"三姑\",{\"fl\":[\"title\",\"asr\",\"ocr\"]}]],\"start_date\":\"2023-06-25\"}", 
            // rule 的json str 包含start_date和end_date
        "de_duplicate": true, // 是否去重
        "limit": 100 // 创建任务时填的limit数
    }
}