沙箱环境接口

本文介绍内容洞察的沙箱环境接口调用方式。

为配合外部客户做功能验证，洞察平台提供对外的沙箱环境，覆盖任务创建，任务变更，任务查询，数据消费等接口。

• 数据为假数据，与线上任务隔离，不会产出计费。
• 所有的调用方式与线上一致，biz_name，token的鉴权方式也与线上一致，仅接口url的前缀不同，需要将调用中的openapi替换成 sandbox_api就是指向沙箱环境。

备注：沙箱环境无需开启ip白名单，可以用非火山机器自行调试。

参考调用指南 ，注意将接口path从：oauth/access_token改为oauth_sandbox/access_token即可指向沙箱环境。

此文档提供四个接口示例供调用。详细的入参，返回接口与正式接口相同。可以看到正式接口的openapi前缀需要换成sandbox_api来指向沙箱接口。

新增任务接口

基本信息

请求参数

Hearder请求参数

Body请求参数

返回参数

调用示例

请求示例

REQ:
POST  /sandbox_api/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序号
    }
}

更新任务接口

基本信息

请求参数

Hearder请求参数

Body请求参数

返回参数

调用示例

请求示例

REQ:
POST  /sandbox_api/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是关闭
    }
}

获取所有任务接口

基本信息

请求参数

Hearder请求参数

返回参数

调用示例

请求示例

REQ:
GET  /sandbox_api/biz_sub/get_task_rules

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

返回示例

RESP:
{
    "status": 0,
    "message": "succeed",
    "data": {
        0: {
           "enable_status": 1, // enable_status 1:开启，0:关闭
           "rule": "{'and',[],[]}" // rule的json dump str
        }, // Key: task_id序号，自增，
        1: {
           "enable_status": 0, // enable_status 1:开启，0:关闭
           "rule": "{'and',[],[]}" // rule的json dump str
        }
    }
}

获取任务状态接口

基本信息

请求参数

Hearder请求参数

Query请求参数

返回参数

调用示例

请求示例

REQ:
GET /sandbox_api/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
    }
}

参考：数据消费接口
需要将openapi前缀需要换成sandbox_api来指向沙箱接口，其他与正式接口相同。注意目前只支持实时接口，还不支持回溯接口的消费和任务创建
注意，默认collector数是10，不可更改。由于沙箱环境数据较少，请尽量创建简单任务来避免无命中。