Dapatkan Pengindeks (Azure AI Search REST API)

  • Artikel

Operasi Dapatkan Pengindeks mendapatkan definisi pengindeks dari Azure AI 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 ke nama unik yang ditentukan pengguna dari layanan pencarian Anda.
nama pengindeks Wajib diisi. URI permintaan menentukan nama pengindeks yang akan dikembalikan.
versi-api Lihat versi API untuk daftar versi yang didukung.

Judul Permintaan

Tabel berikut ini menjelaskan header permintaan yang diperlukan dan opsional.

Bidang Deskripsi
Jenis-Konten Wajib diisi. Set ke application/json
api-key Opsional jika Anda menggunakan peran Azure dan token pembawa disediakan berdasarkan permintaan, jika tidak, kunci diperlukan. Jika Anda menggunakan kunci API, tentukan kunci admin (dibandingkan dengan kunci kueri) untuk mengembalikan informasi objek dari layanan pencarian. Lihat Menyambungkan ke Pencarian Azure AI menggunakan autentikasi kunci untuk detailnya.

Isi Permintaan

Tidak ada.

Respons

Kode Status: 200 OK dikembalikan untuk respons yang berhasil. Responsnya mirip dengan contoh di Create Indexer (Azure AI 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.

Lihat juga