Indexers - Get Status

Layanan:: Search Service

Versi API:: 2024-05-01-preview

Mengembalikan status saat ini dan riwayat eksekusi pengindeks.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string	URL titik akhir layanan pencarian.
indexerName	path	True	string	Nama pengindeks untuk mengambil status.
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://myservice.search.windows.net/indexers('myindexer')/search.status?api-version=2024-05-01-preview

Respon sampel

Kode status:: 200

{
  "status": "running",
  "lastResult": {
    "status": "success",
    "errorMessage": null,
    "startTime": "2014-11-26T03:37:18.853Z",
    "endTime": "2014-11-26T03:37:19.012Z",
    "errors": [],
    "warnings": [],
    "itemsProcessed": 11,
    "itemsFailed": 0,
    "initialTrackingState": null,
    "finalTrackingState": null
  },
  "executionHistory": [
    {
      "status": "success",
      "errorMessage": null,
      "startTime": "2014-11-26T03:37:18.853Z",
      "endTime": "2014-11-26T03:37:19.012Z",
      "errors": [],
      "warnings": [],
      "itemsProcessed": 11,
      "itemsFailed": 0,
      "initialTrackingState": null,
      "finalTrackingState": null
    },
    {
      "status": "transientFailure",
      "errorMessage": null,
      "startTime": "2014-11-26T03:28:10.125Z",
      "endTime": "2014-11-26T03:28:12.007Z",
      "errors": [
        {
          "key": "",
          "errorMessage": "Document key cannot be missing or empty.",
          "statusCode": 400,
          "name": null,
          "details": null,
          "documentationLink": null
        },
        {
          "key": "document id 1",
          "errorMessage": "Could not read the value of column 'foo' at index '0'.",
          "statusCode": 400,
          "name": "DocumentExtraction.AzureBlob.MyDataSource",
          "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.",
          "name": null,
          "details": null,
          "documentationLink": null
        },
        {
          "key": "document id 2",
          "message": "Document was truncated to 50000 characters.",
          "name": "Enrichment.LanguageDetectionSkill.#4",
          "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"
        }
      ],
      "itemsProcessed": 1,
      "itemsFailed": 2,
      "initialTrackingState": null,
      "finalTrackingState": null
    }
  ],
  "limits": {
    "maxRunTime": "PT22H",
    "maxDocumentExtractionSize": 256000000,
    "maxDocumentContentCharactersToExtract": 4000000
  }
}

Definisi

Nama	Deskripsi
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
IndexerCurrentState	Mewakili semua status yang menentukan 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 tempat pengindeks dijalankan.
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

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

IndexerCurrentState

Objek

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

Nama	Jenis	Deskripsi
allDocsFinalChangeTrackingState	string	Ubah nilai status pelacakan saat pengindeksan selesai pada semua dokumen di sumber data.
allDocsInitialChangeTrackingState	string	Status pelacakan perubahan yang digunakan saat pengindeksan dimulai pada semua dokumen di sumber data.
mode	IndexingMode	Mode tempat pengindeks berjalan.
resetDatasourceDocumentIds	string[]	Daftar id dokumen sumber data yang telah direset. Id dokumen sumber data adalah pengidentifikasi unik untuk data di sumber data. Pengindeks akan memprioritaskan penyerapan ulang id ini secara selektif.
resetDocsFinalChangeTrackingState	string	Ubah nilai status pelacakan saat pengindeksan selesai pada pilih, reset dokumen di sumber data.
resetDocsInitialChangeTrackingState	string	Status pelacakan perubahan yang digunakan saat pengindeksan dimulai pada pilih, reset dokumen di sumber data.
resetDocumentKeys	string[]	Daftar kunci dokumen yang telah direset. Kunci dokumen adalah pengidentifikasi unik dokumen untuk data dalam indeks pencarian. Pengindeks akan memprioritaskan penyerapan ulang kunci ini secara selektif.

IndexerExecutionResult

Objek

Mewakili hasil eksekusi pengindeks individual.

Nama	Jenis	Deskripsi
currentState	IndexerCurrentState	Semua status yang menentukan dan menentukan eksekusi pengindeks saat ini.
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 dengan eksekusi pengindeks selesai.
initialTrackingState	string	Ubah status pelacakan dengan mana eksekusi pengindeks dimulai.
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 dan item yang berhasil diproses di mana pengindeksan dicoba tetapi gagal.
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

Enumerasi

Mewakili status eksekusi pengindeks individual.

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

IndexerExecutionStatusDetail

Enumerasi

Merinci status eksekusi pengindeks individual.

Nilai	Deskripsi
resetDocs	Menunjukkan bahwa reset yang terjadi adalah untuk panggilan ke ResetDocs.

IndexerStatus

Enumerasi

Mewakili status pengindeks keseluruhan.

Nilai	Deskripsi
unknown	Menunjukkan bahwa pengindeks dalam keadaan tidak diketahui.
error	Menunjukkan bahwa pengindeks mengalami kesalahan yang tidak dapat dikoreksi tanpa intervensi manusia.
running	Menunjukkan bahwa pengindeks berjalan normal.

IndexingMode

Enumerasi

Mewakili mode tempat pengindeks dijalankan.

Nilai	Deskripsi
indexingAllDocs	Pengindeks mengindeks semua dokumen di sumber data.
indexingResetDocs	Pengindeks mengindeks dokumen selektif dan mengatur ulang di sumber data. Dokumen yang sedang diindeks ditentukan pada status pengindeks.

SearchIndexerError

Objek

Mewakili kesalahan pengindeksan tingkat item atau dokumen.

Nama	Jenis	Deskripsi
details	string	Tambahan, detail verbose tentang kesalahan untuk membantu penelusuran kesalahan 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 pengindeksannya gagal.
name	string	Nama sumber tempat kesalahan berasal. Misalnya, ini dapat merujuk pada keterampilan tertentu dalam skillset yang terlampir. Ini mungkin tidak selalu tersedia.
statusCode	integer (int32)	Kode status yang menunjukkan mengapa operasi pengindeksan gagal. Nilai yang mungkin termasuk: 400 untuk dokumen input cacat, 404 untuk dokumen tidak ditemukan, 409 untuk konflik versi, 422 ketika indeks sementara tidak tersedia, atau 503 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 pengindeks diizinkan untuk dijalankan untuk satu eksekusi.

SearchIndexerStatus

Objek

Mewakili status saat ini dan riwayat eksekusi pengindeks.

Nama	Jenis	Deskripsi
executionHistory	IndexerExecutionResult[]	Riwayat eksekusi pengindeks baru-baru ini, diurutkan dalam urutan kronologis terbalik.
lastResult	IndexerExecutionResult	Hasil dari eksekusi pengindeks terbaru atau yang sedang berlangsung.
limits	SearchIndexerLimits	Batas eksekusi untuk pengindeks.
status	IndexerStatus	Status pengindeks keseluruhan.

SearchIndexerWarning

Objek

Mewakili peringatan tingkat item.

Nama	Jenis	Deskripsi
details	string	Tambahan, detail verbose 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 tempat peringatan berasal. Misalnya, ini dapat merujuk pada keterampilan tertentu dalam skillset yang terlampir. Ini mungkin tidak selalu tersedia.