Dapatkan Pengindeks (Azure Cognitive Search REST API)
Operasi Dapatkan Pengindeks mendapatkan definisi pengindeks dari Azure Cognitive Search.
GET https://[service name].search.windows.net/indexers/[indexer name]?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Parameter URI
| Parameter | Deskripsi |
|---|---|
| nama layanan | Wajib diisi. Atur ini ke nama unik yang ditentukan pengguna dari layanan pencarian Anda. |
| nama pengindeks | Wajib diisi. URI permintaan menentukan nama pengindeks yang akan dikembalikan. |
| versi-api | Wajib diisi. Versi stabil saat ini adalah api-version=2020-06-30. Lihat Versi API untuk versi lainnya. |
Judul Permintaan
Tabel berikut ini menjelaskan header permintaan yang diperlukan dan opsional.
| Bidang | Deskripsi |
|---|---|
| Jenis-Konten | Wajib diisi. Atur titik akhir ini ke application/json |
| api-key | Wajib diisi. Kunci api digunakan untuk mengautentikasi permintaan ke layanan Pencarian Anda. Ini adalah nilai string, unik untuk layanan Anda. Dapatkan permintaan untuk definisi objek harus menyertakan bidang kunci api yang diatur ke kunci admin Anda (dibandingkan dengan kunci kueri). Anda dapat menemukan kunci API di dasbor layanan pencarian di portal Azure. |
Isi Permintaan
Tidak ada.
Respons
Kode Status: 200 OK dikembalikan untuk respons yang berhasil. Responsnya mirip dengan contoh di Create Indexer (Azure Cognitive Search REST API):
{
"name" : "myindexer",
"description" : "a cool indexer",
"dataSourceName" : "ordersds",
"targetIndexName" : "orders",
"schedule" : { "interval" : "PT1H", "startTime" : "2015-01-01T00:00:00Z" },
"parameters" : { "maxFailedItems" : 10, "maxFailedItemsPerBatch" : 5, "base64EncodeKeys": false },
"encryptionKey": null
}
Catatan
Jika pengindeks memiliki kunci enkripsi, layanan pencarian harus memiliki akses ke kunci enkripsi untuk mengambil definisi pengindeks. Tanpa akses ke kunci enkripsi, 400 Permintaan Buruk dikembalikan. Memulihkan akses ke kunci memungkinkan layanan pencarian untuk mengambil definisi pengindeks lagi.