Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
dokumen/batch
Bagian ini menjelaskan permintaan HTTP dan pesan respons untuk documents/batch
sumber daya.
Anda membuat kumpulan dokumen untuk mendeskripsikan data yang ingin Anda unggah ke CloudSearch domain Amazon. Kumpulan dokumen adalah kumpulan operasi tambah dan hapus yang mewakili dokumen yang ingin Anda tambahkan, perbarui, atau hapus dari domain Anda. Batch dapat dijelaskan dalam JSON atau XHTML. Batch menyediakan semua informasi yang CloudSearch dibutuhkan Amazon untuk pengindeksan. Setiap item yang ingin Anda kembalikan sebagai hasil penelusuran (seperti produk) direpresentasikan sebagai dokumen—kumpulan hanyalah kumpulan permintaan tambah dan hapus untuk dokumen individual. Setiap dokumen memiliki ID unik dan satu atau beberapa bidang yang berisi data yang ingin Anda cari dan kembalikan hasilnya.
Untuk memperbarui dokumen, Anda menentukan permintaan tambah dengan ID dokumen dokumen yang ingin Anda perbarui. Untuk informasi selengkapnya, lihat Menambahkan dan Memperbarui Dokumen di Amazon CloudSearch. Demikian pula, untuk menghapus dokumen, Anda mengirimkan permintaan hapus dengan ID dokumen dari dokumen yang ingin Anda hapus. Untuk informasi tentang menghapus dokumen, lihatMenghapus Dokumen di Amazon CloudSearch.
Untuk informasi selengkapnya tentang mengirimkan data untuk pengindeksan, lihat. upload documents
dokumen/batch JSON API
Dokumen JSON/Permintaan batch
Badan documents/batch
permintaan menggunakan JSON atau XMLuntuk menentukan operasi dokumen yang ingin Anda lakukan. Representasi JSON dari batch adalah kumpulan objek yang mendefinisikan operasi tambah dan hapus individu. type
Properti mengidentifikasi apakah suatu objek mewakili operasi tambah atau hapus. Misalnya, batch JSON berikut menambahkan satu dokumen dan menghapus satu dokumen:
[ { "type": "add", "id": "tt0484562", "fields": { "title": "The Seeker: The Dark Is Rising", "directors": ["Cunningham, David L."], "genres": ["Adventure","Drama","Fantasy","Thriller"], "actors": ["McShane, Ian","Eccleston, Christopher","Conroy, Frances", "Crewson, Wendy","Ludwig, Alexander","Cosmo, James", "Warner, Amelia","Hickey, John Benjamin","Piddock, Jim", "Lockhart, Emma"] } }, { "type": "delete", "id": "tt0484575" }]
catatan
Saat menentukan kumpulan dokumen di JSON, nilai untuk bidang tidak bisa. null
Representasi skema JSON
{ "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "type": { "type": "string", "enum": ["add", "delete"], "required": true }, "id": { "type": "string", "pattern": "[a-z0-9][a-z0-9_]{0,127}", "minLength": 1, "maxLength": 128, "required": true }, "fields": { "type": "object", "patternProperties": { "[a-zA-Z0-9][a-zA-Z0-9_]{0,63}": { "type": "string", } } } } } }
dokumen/Properti Permintaan batch (JSON)
Properti | Deskripsi | Diperlukan |
---|---|---|
tipe | Jenis operasi, add ataudelete . |
Ya |
id | String alfanumerik. Karakter yang diizinkan adalah: A-Z (huruf besar), -a-z (huruf kecil), 0-9, _ (garis bawah), - (tanda hubung),/(garis miring), # (tanda hash),: (titik dua). Panjang maksimal adalah 128 karakter. | Ya |
ladang | Kumpulan satu atau lebih properti field_name yang menentukan bidang yang berisi dokumen. Kondisi: Diperlukan untuk menambah operasi. Harus berisi setidaknya satu properti field_name. |
Bersyarat |
field_name | Menentukan bidang dalam dokumen yang ditambahkan. Nama bidang harus dimulai dengan huruf dan dapat berisi karakter berikut: a-z (huruf kecil), 0-9, dan _ (garis bawah). Nama bidang harus minimal 3 dan tidak lebih dari 64 karakter. Skor nama dicadangkan dan tidak dapat digunakan sebagai nama bidang. Untuk menentukan beberapa nilai untuk bidang, Anda menentukan larik nilai, bukan nilai tunggal. Sebagai contoh:
Kondisi: Setidaknya satu bidang harus ditentukan dalam objek bidang. |
Bersyarat |
dokumen/Batch Response (JSON)
Badan respons mencantumkan jumlah penambahan dan penghapusan yang dilakukan dan kesalahan atau peringatan apa pun yang dihasilkan.
Representasi skema JSON dari respons API layanan dokumen ditunjukkan di bawah ini:
{ "type": "object", "properties": { "status": { "type": "text", "enum": ["success", "error"], "required": true }, "adds": { "type": "integer", "minimum": 0, "required": true }, "deletes": { "type": "integer", "minimum": 0, "required": true }, "errors": { "type": "array", "required": false, "items": { "type": "object", "properties": { "message": { "type": "string", "required": true } } } }, "warnings": { "type": "array", "required": false, "items": { "type": "object", "properties": { "message": { "type": "string", "required": true } } } } } }
dokumen/properti respons batch (JSON)
Properti | Deskripsi |
---|---|
status | Status hasil, yaitu salah satu success atauerror . |
menambahkan | Jumlah operasi tambah dokumen yang dilakukan. Selalu nol saat statusnyaerror . |
menghapus | Jumlah operasi hapus dokumen yang dilakukan. Selalu nol saat statusnyaerror . Untuk informasi tentang menghapus dokumen secara permanen, lihatMenghapus Dokumen di Amazon CloudSearch. |
kesalahan | Memberikan informasi tentang kesalahan penguraian atau validasi. Ditentukan hanya jika statusnyaerror . |
memperingati | Memberikan informasi tentang peringatan yang dihasilkan selama penguraian atau validasi. |
dokumen/kode status batch
Permintaan layanan dokumen dapat mengembalikan tiga jenis kode status:
Kode status 5xx menunjukkan bahwa ada kesalahan server internal. Kami merekomendasikan untuk menangkap dan mencoba kembali semua kode kesalahan 5xx karena biasanya mewakili kondisi kesalahan sementara.
Kode status 4xx menunjukkan bahwa permintaan itu salah bentuk.
Kode status 2xx menunjukkan bahwa permintaan berhasil diproses.
Kesalahan | Deskripsi | Kode Status HTTP |
---|---|---|
Tidak Ada Tipe Konten | Header Content-Type tidak ada. | 400 |
Tanpa Konten-Panjang | Header Content-Length tidak ada. | 411 |
Jalan yang salah | Jalur URL tidak cocok dengan “/yyyy-mm-dd/dokumen/batch”. | 404 |
Metode HTTP Tidak Valid | Metode HTTP bukan POST. Permintaan harus diposting ke dokumen/batch. | 405 |
Jenis Terima Tidak Valid | Accept header menentukan jenis konten selain “application/xml"atau"application/json”. Tanggapan dapat dikirim hanya sebagai XML/JSON. | 406 |
Permintaan Terlalu Besar | Panjang badan permintaan lebih besar dari nilai maksimum yang diizinkan. | 413 |
Jenis Konten Tidak Valid | Jenis konten adalah sesuatu selain “application/json” atau “application/xml". | 415 |
Set Karakter Tidak Valid | Set karakter adalah sesuatu selain “ASCII”, “ISO-8859-1", atau “UTF-8". | 415 |
Header Permintaan Umum
Nama | Deskripsi | Diperlukan |
---|---|---|
Content-Type | Tipe MIME standar yang menjelaskan format data objek. Untuk informasi lebih lanjut, lihat W3C RFC 2616 Default: aplikasi/json Kendala: aplikasi/json atau aplikasi/xmlsaja |
Diperlukan |
Content-Length | Panjang dalam byte dari badan permintaan. | Ya |
Menerima | Tipe MIME standar yang menjelaskan format data respons. Untuk informasi lebih lanjut, lihat W3C RFC 2616 Default: tipe konten permintaan Kendala: aplikasi/json atau aplikasi/xmlsaja |
Tidak |
Header Respons Umum
Nama | Penjelasan |
---|---|
Content-Type | Tipe MIME standar yang menjelaskan format data objek. Untuk informasi lebih lanjut, lihat W3C RFC 2616 Default: nilai header Terima dalam permintaan, atau Tipe Konten permintaan jika header Terima hilang atau tidak menentukan aplikasi/xml/aplikasi/json. Kendala: aplikasi/xl atau aplikasi/json saja |
Content-Length | Panjang dalam byte tubuh dalam respon. |