Indexers - Get Status

Servizio:: Search Service

Versione API:: 2025-05-01-preview

Restituisce lo stato corrente e la cronologia di esecuzione di un indicizzatore.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string	URL dell'endpoint del servizio di ricerca.
indexerName	path	True	string	Nome dell'indicizzatore per il quale recuperare lo stato.
api-version	query	True	string	Versione dell'API client.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
x-ms-client-request-id		string (uuid)	ID di rilevamento inviato con la richiesta per facilitare il debug.

Risposte

Nome	Tipo	Descrizione
200 OK	SearchIndexerStatus
Other Status Codes	ErrorResponse	Risposta di errore.

Esempio

SearchServiceGetIndexerStatus

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 200

{
  "status": "running",
  "lastResult": {
    "status": "success",
    "statusDetail": null,
    "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,
    "mode": "indexingAllDocs"
  },
  "executionHistory": [
    {
      "status": "success",
      "statusDetail": null,
      "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,
      "mode": "indexingAllDocs"
    },
    {
      "status": "transientFailure",
      "statusDetail": null,
      "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,
      "mode": "indexingAllDocs"
    }
  ],
  "limits": {
    "maxRunTime": "PT22H",
    "maxDocumentExtractionSize": 256000000,
    "maxDocumentContentCharactersToExtract": 4000000
  },
  "currentState": {
    "mode": "indexingAllDocs",
    "allDocsInitialTrackingState": null,
    "allDocsFinalTrackingState": null,
    "resetDocsInitialTrackingState": null,
    "resetDocsFinalTrackingState": null,
    "resetDocumentKeys": [],
    "resetDatasourceDocumentIds": [],
    "resyncInitialTrackingState": null,
    "resyncFinalTrackingState": null
  }
}

Definizioni

Nome	Descrizione
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
IndexerCurrentState	Rappresenta tutto lo stato che definisce e determina l'esecuzione corrente dell'indicizzatore.
IndexerExecutionResult	Rappresenta il risultato di una singola esecuzione dell'indicizzatore.
IndexerExecutionStatus	Rappresenta lo stato di una singola esecuzione dell'indicizzatore.
IndexerExecutionStatusDetail	Dettaglia lo stato di una singola esecuzione dell'indicizzatore.
IndexerStatus	Rappresenta lo stato complessivo dell'indicizzatore.
IndexingMode	Rappresenta la modalità in cui è in esecuzione l'indicizzatore.
SearchIndexerError	Rappresenta un errore di indicizzazione a livello di elemento o documento.
SearchIndexerLimits
SearchIndexerStatus	Rappresenta lo stato corrente e la cronologia di esecuzione di un indicizzatore.
SearchIndexerWarning	Rappresenta un avviso a livello di elemento.

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

IndexerCurrentState

Oggetto

Rappresenta tutto lo stato che definisce e determina l'esecuzione corrente dell'indicizzatore.

Nome	Tipo	Descrizione
allDocsFinalTrackingState	string	Valore dello stato di rilevamento delle modifiche al termine dell'indicizzazione in tutti i documenti nell'origine dati.
allDocsInitialTrackingState	string	Stato di rilevamento delle modifiche utilizzato quando l'indicizzazione viene avviata in tutti i documenti nell'origine dati.
mode	IndexingMode	Modalità in cui è in esecuzione l'indicizzatore.
resetDatasourceDocumentIds	string[]	Elenco degli ID documento dell'origine dati che sono stati reimpostati. L'ID documento dell'origine dati è l'identificatore univoco per i dati nell'origine dati. L'indicizzatore assegna la priorità in modo selettivo alla reinsezione di questi ID.
resetDocsFinalTrackingState	string	Il valore dello stato di rilevamento delle modifiche al termine dell'indicizzazione alla selezione, reimpostare i documenti nell'origine dati.
resetDocsInitialTrackingState	string	Stato di rilevamento delle modifiche usato all'avvio dell'indicizzazione al momento della selezione, reimpostare i documenti nell'origine dati.
resetDocumentKeys	string[]	Elenco delle chiavi del documento che sono state reimpostate. La chiave del documento è l'identificatore univoco del documento per i dati nell'indice di ricerca. L'indicizzatore assegna la priorità in modo selettivo alla reinsezione selettiva di queste chiavi.
resyncFinalTrackingState	string	Modificare il valore dello stato di rilevamento al termine dell'indicizzazione in base alle opzioni selettive dall'origine dati.
resyncInitialTrackingState	string	Stato di rilevamento delle modifiche utilizzato all'avvio dell'indicizzazione sulle opzioni selettive dell'origine dati.

IndexerExecutionResult

Oggetto

Rappresenta il risultato di una singola esecuzione dell'indicizzatore.

Nome	Tipo	Descrizione
endTime	string (date-time)	Ora di fine dell'esecuzione dell'indicizzatore, se l'esecuzione è già stata completata.
errorMessage	string	Messaggio di errore che indica l'errore di primo livello, se presente.
errors	SearchIndexerError[]	Errori di indicizzazione a livello di elemento.
finalTrackingState	string	Stato di rilevamento delle modifiche con cui è stata completata l'esecuzione dell'indicizzatore.
initialTrackingState	string	Stato di rilevamento delle modifiche con cui è stata avviata un'esecuzione dell'indicizzatore.
itemsFailed	integer (int32)	Numero di elementi che non è stato possibile indicizzare durante l'esecuzione dell'indicizzatore.
itemsProcessed	integer (int32)	Numero di elementi elaborati durante l'esecuzione dell'indicizzatore. Sono inclusi sia gli elementi elaborati correttamente che gli elementi in cui l'indicizzazione è stata tentata ma non è riuscita.
mode	IndexingMode	Modalità in cui è in esecuzione l'indicizzatore.
startTime	string (date-time)	Ora di inizio dell'esecuzione dell'indicizzatore.
status	IndexerExecutionStatus	Risultato dell'esecuzione dell'indicizzatore.
statusDetail	IndexerExecutionStatusDetail	Risultato dell'esecuzione dell'indicizzatore.
warnings	SearchIndexerWarning[]	Avvisi di indicizzazione a livello di elemento.

IndexerExecutionStatus

Enumerazione

Rappresenta lo stato di una singola esecuzione dell'indicizzatore.

Valore	Descrizione
transientFailure	Una chiamata dell'indicizzatore non è riuscita, ma l'errore può essere temporaneo. Le chiamate dell'indicizzatore continueranno per pianificazione.
success	Esecuzione dell'indicizzatore completata correttamente.
inProgress	L'esecuzione dell'indicizzatore è in corso.
reset	L'indicizzatore è stato reimpostato.

IndexerExecutionStatusDetail

Enumerazione

Dettaglia lo stato di una singola esecuzione dell'indicizzatore.

Valore	Descrizione
resetDocs	Indica che la reimpostazione che si è verificata è stata per una chiamata a ResetDocs.
resync	Indica la risincronizzazione selettiva in base alle opzioni dell'origine dati.

IndexerStatus

Enumerazione

Rappresenta lo stato complessivo dell'indicizzatore.

Valore	Descrizione
unknown	Indica che l'indicizzatore è in uno stato sconosciuto.
error	Indica che l'indicizzatore ha riscontrato un errore che non può essere corretto senza intervento umano.
running	Indica che l'indicizzatore è in esecuzione normalmente.

IndexingMode

Enumerazione

Rappresenta la modalità in cui è in esecuzione l'indicizzatore.

Valore	Descrizione
indexingAllDocs	L'indicizzatore indicizza tutti i documenti nell'origine dati.
indexingResetDocs	L'indicizzatore esegue l'indicizzazione di documenti selettivi e reimpostati nell'origine dati. I documenti indicizzati vengono definiti sullo stato dell'indicizzatore.
indexingResync	L'indicizzatore sta risincronizzando e indicizzando le opzioni selettive dall'origine dati.

SearchIndexerError

Oggetto

Rappresenta un errore di indicizzazione a livello di elemento o documento.

Nome	Tipo	Descrizione
details	string	Informazioni dettagliate aggiuntive sull'errore per facilitare il debug dell'indicizzatore. Questo potrebbe non essere sempre disponibile.
documentationLink	string	Collegamento a una guida alla risoluzione dei problemi per queste classi di errori. Questo potrebbe non essere sempre disponibile.
errorMessage	string	Messaggio che descrive l'errore che si è verificato durante l'elaborazione dell'elemento.
key	string	Chiave dell'elemento per cui l'indicizzazione non è riuscita.
name	string	Nome dell'origine in cui ha avuto origine l'errore. Ad esempio, questo potrebbe fare riferimento a una particolare competenza nel set di competenze associato. Questo potrebbe non essere sempre disponibile.
statusCode	integer (int32)	Codice di stato che indica il motivo per cui l'operazione di indicizzazione non è riuscita. I valori possibili includono: 400 per un documento di input in formato non valido, 404 per il documento non trovato, 409 per un conflitto di versione, 422 quando l'indice è temporaneamente non disponibile o 503 per quando il servizio è troppo occupato.

SearchIndexerLimits

Oggetto

Nome	Tipo	Descrizione
maxDocumentContentCharactersToExtract	number (int64)	Numero massimo di caratteri che verranno estratti da un documento prelevato per l'indicizzazione.
maxDocumentExtractionSize	number (int64)	Dimensioni massime di un documento, in byte, che verranno considerate valide per l'indicizzazione.
maxRunTime	string (duration)	Durata massima consentita per l'esecuzione dell'indicizzatore per un'esecuzione.

SearchIndexerStatus

Oggetto

Rappresenta lo stato corrente e la cronologia di esecuzione di un indicizzatore.

Nome	Tipo	Descrizione
currentState	IndexerCurrentState	Tutto lo stato che definisce e determina l'esecuzione corrente dell'indicizzatore.
executionHistory	IndexerExecutionResult[]	Cronologia delle esecuzioni recenti dell'indicizzatore, ordinate in ordine cronologico inverso.
lastResult	IndexerExecutionResult	Risultato dell'esecuzione dell'indicizzatore più recente o in corso.
limits	SearchIndexerLimits	Limiti di esecuzione per l'indicizzatore.
status	IndexerStatus	Stato complessivo dell'indicizzatore.

SearchIndexerWarning

Oggetto

Rappresenta un avviso a livello di elemento.

Nome	Tipo	Descrizione
details	string	Dettagli aggiuntivi e dettagliato sull'avviso per facilitare il debug dell'indicizzatore. Questo potrebbe non essere sempre disponibile.
documentationLink	string	Collegamento a una guida alla risoluzione dei problemi per queste classi di avvisi. Questo potrebbe non essere sempre disponibile.
key	string	Chiave dell'elemento che ha generato un avviso.
message	string	Messaggio che descrive l'avviso che si è verificato durante l'elaborazione dell'elemento.
name	string	Nome dell'origine in cui ha avuto origine l'avviso. Ad esempio, questo potrebbe fare riferimento a una particolare competenza nel set di competenze associato. Questo potrebbe non essere sempre disponibile.