Pengindeks Daftar (Azure AI Search REST API)
Operasi Daftar Pengindeks mengembalikan daftar pengindeks di layanan Pencarian Azure AI Anda.
GET https://[service name].search.windows.net/indexers?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. |
| 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 | Opsional jika Anda menggunakan peran Azure dan token pembawa disediakan berdasarkan permintaan, jika tidak, kunci diperlukan. Kunci api adalah string unik yang dihasilkan sistem yang mengautentikasi permintaan ke layanan pencarian Anda. Dapatkan permintaan untuk definisi objek harus menyertakan bidang kunci api yang diatur ke kunci admin Anda (dibandingkan dengan kunci kueri). Lihat Menyambungkan ke Azure AI Search menggunakan autentikasi kunci untuk detailnya. |
Isi Permintaan
Tidak ada.
Respons
Untuk permintaan yang berhasil: 200 OK. Berikut adalah contoh isi respons:
{
"value" : [
{
"name" : "myindexer",
"description" : "a cool indexer",
"dataSourceName" : "ordersds",
"targetIndexName" : "orders",
... other indexer properties
}]
}
Anda dapat memfilter respons hanya ke properti yang Anda minati. Misalnya, jika Anda hanya menginginkan daftar nama pengindeks, gunakan opsi kueri $select OData:
GET /indexers?api-version=2020-06-30&$select=name
Dalam hal ini, respons dari contoh di atas akan muncul sebagai berikut:
{
"value" : [ { "name": "myindexer" } ]
}
Ini adalah teknik yang berguna untuk menghemat bandwidth jika Anda memiliki banyak pengindeks di layanan Pencarian Anda.
Catatan
Jika pengindeks memiliki kunci enkripsi, layanan pencarian harus memiliki akses ke kunci enkripsi untuk mengambil properti terenkripsi dalam definisi pengindeks tersebut. Tanpa akses ke kunci enkripsi, "<encrypted>" tempat penampung dikembalikan sebagai pengganti properti terenkripsi. Memulihkan akses ke kunci memungkinkan layanan pencarian untuk mengambil definisi pengindeks lengkap lagi.