Knowledge Sources - Get Status

Layanan:: Search Service

Versi API:: 2026-04-01

Mengambil status sumber pengetahuan.

GET {endpoint}/knowledgesources('{sourceName}')/status?api-version=2026-04-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string (uri)	URL titik akhir layanan pencarian.
sourceName	path	True	string	Nama sumber pengetahuan.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
Accept		Accept	Header Terima.
x-ms-client-request-id		string (uuid)	Pengidentifikasi string yang buram dan unik secara global yang dihasilkan klien untuk permintaan tersebut.

Respons

Nama	Jenis	Deskripsi
200 OK	KnowledgeSourceStatus	Permintaan telah berhasil.
Other Status Codes	ErrorResponse	Respons kesalahan tak terduga.

Keamanan

api-key

Jenis: apiKey
Dalam: header

OAuth2Auth

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Cakupan

Nama	Deskripsi
https://search.azure.com/.default

Contoh

SearchServiceGetKnowledgeSourceStatus

Permintaan sampel

HTTP

GET https://exampleservice.search.windows.net/knowledgesources('ks-example-index')/status?api-version=2026-04-01

Respon sampel

Kode status:: 200

{
  "kind": "searchIndex",
  "synchronizationStatus": "active",
  "synchronizationInterval": "1d",
  "currentSynchronizationState": {
    "startTime": "2024-11-26T03:37:18.853Z",
    "itemsUpdatesProcessed": 10,
    "itemsUpdatesFailed": 2,
    "itemsSkipped": 1
  },
  "lastSynchronizationState": {
    "startTime": "2024-11-25T03:37:18.853Z",
    "endTime": "2024-11-25T03:38:19.012Z",
    "itemsUpdatesProcessed": 8,
    "itemsUpdatesFailed": 1,
    "itemsSkipped": 0
  },
  "statistics": {
    "totalSynchronization": 5,
    "averageSynchronizationDuration": "PT30M",
    "averageItemsProcessedPerSynchronization": 100
  }
}

Definisi

Nama	Deskripsi
Accept	Header Terima.
CompletedSynchronizationState	Mewakili status selesai sinkronisasi terakhir.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.).
KnowledgeSourceKind	Jenis sumber pengetahuan.
KnowledgeSourceStatistics	Informasi statistik tentang riwayat sinkronisasi sumber pengetahuan.
KnowledgeSourceStatus	Mewakili status dan riwayat sinkronisasi sumber pengetahuan.
KnowledgeSourceSynchronizationError	Mewakili kesalahan pengindeksan tingkat dokumen yang ditemui selama eksekusi sinkronisasi sumber pengetahuan.
KnowledgeSourceSynchronizationStatus	Status sinkronisasi sumber pengetahuan saat ini.
SynchronizationState	Mewakili status sinkronisasi berkelanjutan saat ini yang menjangkau beberapa eksekusi pengindeks.

Accept

Enumerasi

Header Terima.

Nilai	Deskripsi
application/json;odata.metadata=minimal

CompletedSynchronizationState

Objek

Mewakili status selesai sinkronisasi terakhir.

Nama	Jenis	Deskripsi
endTime	string (date-time)	Waktu akhir sinkronisasi terakhir yang diselesaikan.
itemsSkipped	integer (int32)	Jumlah item yang dilewati dalam sinkronisasi terakhir.
itemsUpdatesFailed	integer (int32)	Jumlah pembaruan item yang gagal dalam sinkronisasi terakhir.
itemsUpdatesProcessed	integer (int32)	Jumlah pembaruan item yang berhasil diproses dalam sinkronisasi terakhir.
startTime	string (date-time)	Waktu mulai sinkronisasi terakhir yang telah selesai.

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info		Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Rincian kesalahan.
message	string	Pesan kesalahan.
target	string	Sasaran kesalahan.

ErrorResponse

Objek

Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.).

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

KnowledgeSourceKind

Enumerasi

Jenis sumber pengetahuan.

Nilai	Deskripsi
searchIndex	Sumber pengetahuan yang membaca data dari Indeks Pencarian.
azureBlob	Sumber pengetahuan yang membaca dan menyerap data dari Azure Blob Storage ke Indeks Pencarian.
indexedOneLake	Sumber pengetahuan yang membaca data dari OneLake yang diindeks.
web	Sumber pengetahuan yang membaca data dari web.

KnowledgeSourceStatistics

Objek

Informasi statistik tentang riwayat sinkronisasi sumber pengetahuan.

Nama	Jenis	Deskripsi
averageItemsProcessedPerSynchronization	integer (int32)	Rata-rata item yang diproses per sinkronisasi.
averageSynchronizationDuration	string	Durasi sinkronisasi rata-rata dalam format HH:MM:SS.
totalSynchronization	integer (int32)	Jumlah total sinkronisasi.

KnowledgeSourceStatus

Objek

Mewakili status dan riwayat sinkronisasi sumber pengetahuan.

Nama	Jenis	Deskripsi
currentSynchronizationState	SynchronizationState	Status sinkronisasi saat ini yang mencakup beberapa eksekusi pengindeks.
kind	KnowledgeSourceKind	Mengidentifikasi jenis Sumber Pengetahuan langsung dari respons Status.
lastSynchronizationState	CompletedSynchronizationState	Detail sinkronisasi terakhir yang telah selesai. Null pada sinkronisasi pertama.
statistics	KnowledgeSourceStatistics	Informasi statistik tentang riwayat sinkronisasi sumber pengetahuan. Null pada sinkronisasi pertama.
synchronizationInterval	string	Interval sinkronisasi (misalnya, '1d' untuk harian). Null jika tidak ada jadwal yang dikonfigurasi.
synchronizationStatus	KnowledgeSourceSynchronizationStatus	Status sinkronisasi saat ini.

KnowledgeSourceSynchronizationError

Objek

Mewakili kesalahan pengindeksan tingkat dokumen yang ditemui selama eksekusi sinkronisasi sumber pengetahuan.

Nama	Jenis	Deskripsi
details	string	Informasi kontekstual tambahan tentang kegagalan.
docId	string	Pengidentifikasi unik untuk dokumen atau item yang gagal dalam eksekusi sinkronisasi.
documentationLink	string	Tautan ke dokumentasi pemecahan masalah yang relevan.
errorMessage	string	Pesan kesalahan yang dapat dibaca manusia dan dapat dilihat pelanggan.
name	string	Nama komponen penyerapan atau pemrosesan yang melaporkan kesalahan.
statusCode	integer (int32)	Kode status seperti HTTP yang mewakili kategori kegagalan (misalnya, 400).

KnowledgeSourceSynchronizationStatus

Enumerasi

Status sinkronisasi sumber pengetahuan saat ini.

Nilai	Deskripsi
creating	Sumber pengetahuan sedang disediakan.
active	Sumber pengetahuan aktif dan sinkronisasi berjalan terjadi.
deleting	Sumber pengetahuan sedang dihapus dan sinkronisasi dijeda.

SynchronizationState

Objek

Mewakili status sinkronisasi berkelanjutan saat ini yang menjangkau beberapa eksekusi pengindeks.

Nama	Jenis	Deskripsi
errors	KnowledgeSourceSynchronizationError[]	Pengumpulan kesalahan pengindeksan tingkat dokumen yang ditemui selama eksekusi sinkronisasi saat ini. Ditampilkan hanya jika ada kesalahan.
itemsSkipped	integer (int32)	Jumlah item yang dilewati dalam sinkronisasi saat ini.
itemsUpdatesFailed	integer (int32)	Jumlah pembaruan item yang gagal dalam sinkronisasi saat ini.
itemsUpdatesProcessed	integer (int32)	Jumlah pembaruan item yang berhasil diproses dalam sinkronisasi saat ini.
startTime	string (date-time)	Waktu mulai sinkronisasi saat ini.