调用API向应用推送采集数据-智能开放搜索 OpenSearch-阿里云

描述

给指定的应用推送采集数据

方法

POST

URI

/v3/openapi/app-groups/{appName}/data-collections/{dataCollectionName}/data-collection-type/{dataCollectionType}/actions/bulk

appName 指的是 opensearch 应⽤名称
dataCollectionName 指的是数据采集名称，默认为 opensearch 应⽤名称
dataCollectionType 指的是数据采集类型，为 USER、ITEM_INFO、BEHAVIOR、INDUSTRY_SPECIFIC 四种类型之一
以上省略了请求 Header 参数，省略了访问 opensearch 服务的 Host 地址，详细请求结构请参考文档

请求参数

名称	类型	是否必选	描述
docs	List	是	由Doc组成的数据

Doc 的参数

名称	类型	是否必选	描述
cmd	String	是	操作指令，必须为 ADD
fields	Map	是	字段组合

fields 的参数

fields 是指定表的字段组合，我们定义了不同类型的表结构，分别是用户表、物品表和行为表。例如需要向其行为表推送数据的时候，fields 就应该是行为表中的定义的字段。

名称	类型	是否必选	描述
field1	xxx	是	表字段
field2	xxx	是	表字段

返回参数

参数	类型	描述
errors	List	错误内容
status	String	status：执行结果，OK为成功，FAIL为失败，请根据返回错误码进行排查
request_id	String	当前请求的 request_id
result	Boolean	执行成功返回该参数，值为true，报错不返回该参数

示例

请求示例

POST /v3/openapi/app-groups/zhao_special/data-collections/zhao_special/data-collection-type/behavior/actions/bulk

[
  {
    "cmd": "ADD",
    "fields": {
        "sdk_type": "opensearch_sdk",
        "sdk_version": "3.2.0",
        "user_id": "10469628",
        "biz_id": 123,
        "trace_id": "231084198510103333",
        "item_id": "id",
        "item_type": "item",
        "bhv_type": "click",
        "reach_time": "20190730105931"
    }
  }
]

正常返回示例

{
    "errors": [],
    "request_id": "155084740119723291017595",
    "status": "OK",
    "result": true
}