Ikhtisar
Anda dapat memanggil operasi API untuk mendorong data yang dikumpulkan ke aplikasi tertentu.
Metode permintaan HTTP yang didukung
POST
URL
/v3/openapi/app-groups/{appName}/data-collections/{dataCollectionName}/data-collection-type/{dataCollectionType}/actions/bulkGanti parameter appName dengan nama aplikasi OpenSearch Anda.
Ganti parameter dataCollectionName dengan nama koleksi data yang akan didorong. Secara default, atur parameter ini ke nama aplikasi OpenSearch Anda.
Ganti parameter dataCollectionType dengan jenis data yang akan didorong. Nilai yang valid: USER, ITEM_INFO, BEHAVIOR, dan INDUSTRY_SPECIFIC.
Contoh URL di atas menghilangkan informasi seperti parameter dalam header permintaan dan titik akhir yang digunakan untuk terhubung ke OpenSearch. Untuk informasi lebih lanjut tentang struktur permintaan lengkap, lihat Struktur Permintaan.
Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
|---|---|---|---|
docs | Daftar | Ya | Sebuah daftar dokumen. |
Parameter terkait dokumen
Parameter | Tipe | Diperlukan | Deskripsi |
|---|---|---|---|
cmd | String | Ya | Operasi yang akan dilakukan pada dokumen. Atur nilainya menjadi ADD. |
fields | Map | Ya | Koleksi bidang. |
Parameter fields
Nilai dari parameter fields adalah kumpulan bidang dalam tabel tertentu. OpenSearch mendukung berbagai jenis tabel dengan skema yang berbeda: tabel pengguna, tabel item, dan tabel perilaku. Sebagai contoh, jika Anda ingin mendorong data ke tabel perilaku, parameter fields harus berisi bidang yang didefinisikan dalam tabel perilaku. Untuk informasi lebih lanjut, lihat Pengumpulan Data 2.0.
Parameter | Tipe | Diperlukan | Deskripsi |
|---|---|---|---|
field1 | xxx | Ya | Bidang dalam tabel tertentu. |
field2 | xxx | Ya | Bidang dalam tabel tertentu. |
Parameter respons
Parameter | Tipe | Deskripsi |
|---|---|---|
errors | Daftar | Rincian kesalahan. |
status | String | Hasil eksekusi permintaan. Nilai yang valid: OK dan FAIL. Nilai OK menunjukkan bahwa permintaan berhasil. Nilai FAIL menunjukkan bahwa permintaan gagal. Dalam hal ini, perbaiki kesalahan berdasarkan kode kesalahan. |
request_id | String | ID permintaan. |
result | Boolean | Hasil permintaan. Nilai true dikembalikan untuk permintaan yang berhasil. Parameter ini tidak dikembalikan untuk permintaan yang gagal. |
Contoh
Contoh Permintaan
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"
}
}
]Contoh Respons Sukses
{
"errors": [],
"request_id": "155084740119723291017595",
"status": "OK",
"result": true
}