Indexers - Get Status

Layanan:: Search Service

Versi API:: 2025-08-01-preview

Mengembalikan status saat ini dan riwayat eksekusi pengindeks.

GET {endpoint}/indexers('{indexerName}')/search.status?api-version=2025-08-01-preview

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string	URL titik akhir layanan pencarian.
indexerName	path	True	string	Nama pengindeks yang akan diambil statusnya.
api-version	query	True	string	Versi API Klien.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
x-ms-client-request-id		string (uuid)	ID pelacakan yang dikirim dengan permintaan untuk membantu penelusuran kesalahan.

Respons

Nama	Jenis	Deskripsi
200 OK	SearchIndexerStatus
Other Status Codes	ErrorResponse	Respons kesalahan.

Contoh

SearchServiceGetIndexerStatus

Permintaan sampel

HTTP

GET https://previewexampleservice.search.windows.net/indexers('myindexer')/search.status?api-version=2025-08-01-preview

Respon sampel

Kode status:: 200

{
  "name": "myindexer",
  "status": "running",
  "lastResult": {
    "status": "success",
    "startTime": "2014-11-26T03:37:18.853Z",
    "endTime": "2014-11-26T03:37:19.012Z",
    "itemsProcessed": 11,
    "itemsFailed": 0,
    "mode": "indexingAllDocs",
    "errors": [],
    "warnings": []
  },
  "executionHistory": [
    {
      "status": "success",
      "startTime": "2014-11-26T03:37:18.853Z",
      "endTime": "2014-11-26T03:37:19.012Z",
      "itemsProcessed": 11,
      "itemsFailed": 0,
      "mode": "indexingAllDocs",
      "errors": [],
      "warnings": []
    },
    {
      "status": "transientFailure",
      "startTime": "2014-11-26T03:28:10.125Z",
      "endTime": "2014-11-26T03:28:12.007Z",
      "itemsProcessed": 1,
      "itemsFailed": 2,
      "mode": "indexingAllDocs",
      "errors": [
        {
          "key": "",
          "statusCode": 400,
          "errorMessage": "Document key cannot be missing or empty."
        },
        {
          "key": "document id 1",
          "statusCode": 400,
          "name": "DocumentExtraction.AzureBlob.MyDataSource",
          "errorMessage": "Could not read the value of column 'foo' at index '0'.",
          "details": "The file could not be parsed.",
          "documentationLink": "https://go.microsoft.com/fwlink/?linkid=2049388"
        }
      ],
      "warnings": [
        {
          "key": "document id",
          "message": "A warning doesn't stop indexing, and is intended to inform you of certain interesting situations, like when a blob indexer truncates the amount of text extracted from a blob."
        },
        {
          "key": "document id 2",
          "name": "Enrichment.LanguageDetectionSkill.#4",
          "message": "Document was truncated to 50000 characters.",
          "details": "The skill did something that didn't break anything, nonetheless something we didn't expect happened, so it might be worth double checking.",
          "documentationLink": "https://go.microsoft.com/fwlink/?linkid=2099692"
        }
      ]
    }
  ],
  "limits": {
    "maxRunTime": "PT22H",
    "maxDocumentExtractionSize": 256000000,
    "maxDocumentContentCharactersToExtract": 4000000
  },
  "currentState": {
    "mode": "indexingAllDocs",
    "resetDocumentKeys": [],
    "resetDatasourceDocumentIds": []
  }
}

Definisi

Nama	Deskripsi
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Tanggapan kesalahan
IndexerCurrentState	Mewakili semua status yang mendefinisikan dan menentukan eksekusi pengindeks saat ini.
IndexerExecutionResult	Mewakili hasil eksekusi pengindeks individual.
IndexerExecutionStatus	Mewakili status eksekusi pengindeks individual.
IndexerExecutionStatusDetail	Merinci status eksekusi pengindeks individual.
IndexerStatus	Mewakili status pengindeks keseluruhan.
IndexingMode	Mewakili mode yang dijalankan pengindeks.
SearchIndexerError	Mewakili kesalahan pengindeksan tingkat item atau dokumen.
SearchIndexerLimits
SearchIndexerStatus	Mewakili status saat ini dan riwayat eksekusi pengindeks.
SearchIndexerWarning	Mewakili peringatan tingkat item.

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	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[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Tanggapan kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

IndexerCurrentState

Objek

Mewakili semua status yang mendefinisikan dan menentukan eksekusi pengindeks saat ini.

Nama	Jenis	Deskripsi
allDocsFinalTrackingState	string	Ubah nilai status pelacakan saat pengindeksan selesai pada semua dokumen di sumber data.
allDocsInitialTrackingState	string	Ubah status pelacakan yang digunakan saat pengindeksan dimulai pada semua dokumen di sumber data.
mode	IndexingMode	Mode pengindeks berjalan.
resetDatasourceDocumentIds	string[]	Daftar id dokumen sumber data yang telah diatur ulang. ID dokumen sumber data adalah pengidentifikasi unik untuk data dalam sumber data. Pengindeks akan memprioritaskan penyerapan ulang id ini secara selektif.
resetDocsFinalTrackingState	string	Ubah nilai status pelacakan saat pengindeksan selesai pada memilih dan mengatur ulang dokumen di sumber data.
resetDocsInitialTrackingState	string	Ubah status pelacakan yang digunakan saat pengindeksan dimulai pada pilih dan atur ulang dokumen di sumber data.
resetDocumentKeys	string[]	Daftar kunci dokumen yang telah diatur ulang. Kunci dokumen adalah pengidentifikasi unik dokumen untuk data dalam indeks pencarian. Pengindeks akan memprioritaskan penyerapan ulang kunci ini secara selektif.
resyncFinalTrackingState	string	Ubah nilai status pelacakan saat pengindeksan selesai pada opsi selektif dari sumber data.
resyncInitialTrackingState	string	Ubah status pelacakan yang digunakan saat pengindeksan dimulai pada opsi selektif dari sumber data.

IndexerExecutionResult

Objek

Mewakili hasil eksekusi pengindeks individual.

Nama	Jenis	Deskripsi
endTime	string (date-time)	Waktu akhir eksekusi pengindeks ini, jika eksekusi telah selesai.
errorMessage	string	Pesan kesalahan yang menunjukkan kesalahan tingkat atas, jika ada.
errors	SearchIndexerError[]	Kesalahan pengindeksan tingkat item.
finalTrackingState	string	Ubah status pelacakan yang digunakan untuk menyelesaikan eksekusi pengindeks.
initialTrackingState	string	Ubah status pelacakan yang digunakan untuk memulai eksekusi pengindeks.
itemsFailed	integer (int32)	Jumlah item yang gagal diindeks selama eksekusi pengindeks ini.
itemsProcessed	integer (int32)	Jumlah item yang diproses selama eksekusi pengindeks ini. Ini termasuk item yang berhasil diproses dan item di mana pengindeksan dicoba tetapi gagal.
mode	IndexingMode	Mode pengindeks berjalan.
startTime	string (date-time)	Waktu mulai eksekusi pengindeks ini.
status	IndexerExecutionStatus	Hasil dari eksekusi pengindeks ini.
statusDetail	IndexerExecutionStatusDetail	Hasil dari eksekusi pengindeks ini.
warnings	SearchIndexerWarning[]	Peringatan pengindeksan tingkat item.

IndexerExecutionStatus

Enumeration

Mewakili status eksekusi pengindeks individual.

Nilai	Deskripsi
transientFailure	Pemanggilan pengindeks telah gagal, tetapi kegagalannya mungkin bersifat sementara. Pemanggilan pengindeks akan berlanjut sesuai jadwal.
success	Eksekusi pengindeks berhasil diselesaikan.
inProgress	Eksekusi pengindeks sedang berlangsung.
reset	Pengindeks telah diatur ulang.

IndexerExecutionStatusDetail

Enumeration

Merinci status eksekusi pengindeks individual.

Nilai	Deskripsi
resetDocs	Menunjukkan bahwa reset yang terjadi adalah untuk panggilan ke ResetDocs.
resync	Menunjukkan untuk menyinkronkan ulang secara selektif berdasarkan opsi dari sumber data.

IndexerStatus

Enumeration

Mewakili status pengindeks keseluruhan.

Nilai	Deskripsi
unknown	Menunjukkan bahwa pengindeks berada dalam keadaan tidak diketahui.
error	Menunjukkan bahwa pengindeks mengalami kesalahan yang tidak dapat diperbaiki tanpa campur tangan manusia.
running	Menunjukkan bahwa pengindeks berjalan normal.

IndexingMode

Enumeration

Mewakili mode yang dijalankan pengindeks.

Nilai	Deskripsi
indexingAllDocs	Pengindeks mengindeks semua dokumen di sumber data.
indexingResetDocs	Pengindeks mengindeks selektif, mengatur ulang dokumen di sumber data. Dokumen yang diindeks ditentukan pada status pengindeks.
indexingResync	Pengindeks menyinkronkan ulang dan mengindeks opsi selektif dari sumber data.

SearchIndexerError

Objek

Mewakili kesalahan pengindeksan tingkat item atau dokumen.

Nama	Jenis	Deskripsi
details	string	Tambahan detail bertele-tele tentang kesalahan untuk membantu men-debug pengindeks. Ini mungkin tidak selalu tersedia.
documentationLink	string	Tautan ke panduan pemecahan masalah untuk kelas kesalahan ini. Ini mungkin tidak selalu tersedia.
errorMessage	string	Pesan yang menjelaskan kesalahan yang terjadi saat memproses item.
key	string	Kunci item yang pengindekannya gagal.
name	string	Nama sumber asal kesalahan. Misalnya, ini bisa merujuk pada keterampilan tertentu dalam keahlian terlampir. Ini mungkin tidak selalu tersedia.
statusCode	integer (int32)	Kode status yang menunjukkan mengapa operasi pengindeksan gagal. Nilai yang mungkin meliputi: 400 untuk dokumen input yang salah bentuk, 404 untuk dokumen tidak ditemukan, 409 untuk konflik versi, 422 saat indeks tidak tersedia untuk sementara, atau 503 untuk saat layanan terlalu sibuk.

SearchIndexerLimits

Objek

Nama	Jenis	Deskripsi
maxDocumentContentCharactersToExtract	number (int64)	Jumlah maksimum karakter yang akan diekstrak dari dokumen yang diambil untuk pengindeksan.
maxDocumentExtractionSize	number (int64)	Ukuran maksimum dokumen, dalam byte, yang akan dianggap valid untuk pengindeksan.
maxRunTime	string (duration)	Durasi maksimum yang diizinkan untuk dijalankan oleh pengindeks untuk satu eksekusi.

SearchIndexerStatus

Objek

Mewakili status saat ini dan riwayat eksekusi pengindeks.

Nama	Jenis	Deskripsi
currentState	IndexerCurrentState	Semua status yang mendefinisikan dan menentukan eksekusi pengindeks saat ini.
executionHistory	IndexerExecutionResult[]	Sejarah eksekusi pengindeks baru-baru ini, diurutkan dalam urutan kronologis terbalik.
lastResult	IndexerExecutionResult	Hasil eksekusi pengindeks terbaru atau yang sedang berlangsung.
limits	SearchIndexerLimits	Batas eksekusi untuk pengindeks.
name	string	Nama pengindeks.
status	IndexerStatus	Status pengindeks keseluruhan.

SearchIndexerWarning

Objek

Mewakili peringatan tingkat item.

Nama	Jenis	Deskripsi
details	string	Detail tambahan dan bertele-tele tentang peringatan untuk membantu men-debug pengindeks. Ini mungkin tidak selalu tersedia.
documentationLink	string	Tautan ke panduan pemecahan masalah untuk kelas peringatan ini. Ini mungkin tidak selalu tersedia.
key	string	Kunci item yang menghasilkan peringatan.
message	string	Pesan yang menjelaskan peringatan yang terjadi saat memproses item.
name	string	Nama sumber asal peringatan tersebut. Misalnya, ini bisa merujuk pada keterampilan tertentu dalam keahlian terlampir. Ini mungkin tidak selalu tersedia.

Bagikan melalui

Indexers - Get Status

Parameter URI

Header Permintaan

Respons

Contoh

SearchServiceGetIndexerStatus

Permintaan sampel

Respon sampel

Definisi

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IndexerCurrentState

IndexerExecutionResult

IndexerExecutionStatus

IndexerExecutionStatusDetail

IndexerStatus

IndexingMode

SearchIndexerError

SearchIndexerLimits

SearchIndexerStatus

SearchIndexerWarning