全部產品
Search
文件中心

OpenSearch:推送採集資料

更新時間:Jul 13, 2024

描述

給指定的應用推送採集資料

方法

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
}