Indexers - Get Status

Riferimento

Servizio:: Search Service

Versione API:: 2023-11-01

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

GET {endpoint}/indexers('{indexerName}')/search.status?api-version=2023-11-01

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 cui è necessario recuperare lo stato.
api-version	query	True	string	Versione api client.

Intestazione della richiesta

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

Risposte

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

Esempio

SearchServiceGetIndexerStatus

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 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
  }
}

Definizioni

Nome	Descrizione
IndexerExecutionResult	Rappresenta il risultato di una singola esecuzione dell'indicizzatore.
IndexerExecutionStatus	Rappresenta lo stato di una singola esecuzione dell'indicizzatore.
IndexerStatus	Rappresenta lo stato complessivo dell'indice.
SearchError	Descrive una condizione di errore per l'API.
SearchIndexerError	Rappresenta un errore di indicizzazione a livello dell'elemento o del documento.
SearchIndexerLimits
SearchIndexerStatus	Rappresenta lo stato corrente e la cronologia di esecuzione di un indicizzatore.
SearchIndexerWarning	Rappresenta un avviso a livello di elemento.

IndexerExecutionResult

Rappresenta il risultato di una singola esecuzione dell'indicizzatore.

Nome	Tipo	Descrizione
endTime	string	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	Numero di elementi che non è stato possibile indicizzare durante l'esecuzione dell'indicizzatore.
itemsProcessed	integer	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.
startTime	string	Ora di inizio dell'esecuzione dell'indicizzatore.
status	IndexerExecutionStatus	Risultato dell'esecuzione dell'indicizzatore.
warnings	SearchIndexerWarning[]	Avvisi di indicizzazione a livello di elemento.

IndexerExecutionStatus

Rappresenta lo stato di una singola esecuzione dell'indicizzatore.

Nome	Tipo	Descrizione
inProgress	string	L'esecuzione dell'indicizzatore è in corso.
reset	string	L'indicizzatore è stato reimpostato.
success	string	L'esecuzione dell'indicizzatore è stata completata.
transientFailure	string	La chiamata all'indicizzatore non è riuscita, ma l'errore potrebbe essere temporaneo. Gli indicizzatori continueranno a essere chiamati in base alla pianificazione.

IndexerStatus

Rappresenta lo stato complessivo dell'indice.

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

SearchError

Descrive una condizione di errore per l'API.

Nome	Tipo	Descrizione
code	string	Uno dei set definiti dal server di codici di errore.
details	SearchError[]	Matrice di dettagli sugli errori specifici che hanno causato questo errore segnalato.
message	string	Rappresentazione leggibile dell'errore.

SearchIndexerError

Rappresenta un errore di indicizzazione a livello dell'elemento o del documento.

Nome	Tipo	Descrizione
details	string	Dettagli aggiuntivi 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	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

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

SearchIndexerStatus

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

Nome	Tipo	Descrizione
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

Rappresenta un avviso a livello di elemento.

Nome	Tipo	Descrizione
details	string	Dettagli aggiuntivi 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.

Condividi tramite