Indexers - Get Status

Riferimento

Service:: Search Service

API Version:: 2023-10-01-Preview

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

GET {endpoint}/indexers('{indexerName}')/search.status?api-version=2023-10-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 cui è necessario 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 di assistenza per il debug.

Risposte

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

Esempio

SearchServiceGetIndexerStatus

Sample Request

HTTP

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

Sample Response

Status code:: 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
IndexerCurrentState	Rappresenta tutto lo stato che definisce e determina l'esecuzione corrente dell'indicizzatore.
IndexerExecutionResult	Rappresenta il risultato di un'esecuzione singola dell'indicizzatore.
IndexerExecutionStatus	Rappresenta lo stato di una singola esecuzione dell'indicizzatore.
IndexerExecutionStatusDetail	Dettaglia lo stato di un singolo indicizzatore.
IndexerStatus	Rappresenta lo stato complessivo dell'indice.
IndexingMode	Rappresenta la modalità in cui viene eseguito l'indicizzatore.
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.

IndexerCurrentState

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

Nome	Tipo	Descrizione
allDocsFinalChangeTrackingState	string	Modificare il valore dello stato di rilevamento al termine dell'indicizzazione in tutti i documenti nell'origine dati.
allDocsInitialChangeTrackingState	string	Stato di rilevamento delle modifiche utilizzato quando l'indicizzazione inizia su tutti i documenti nell'origine dati.
mode	IndexingMode	La 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à selettivamente alla rigestizione di questi ID.
resetDocsFinalChangeTrackingState	string	Modificare il valore dello stato di rilevamento al termine dell'indicizzazione in selezione, reimpostare i documenti nell'origine dati.
resetDocsInitialChangeTrackingState	string	Modificare lo stato di rilevamento usato quando l'indicizzazione inizia a selezionare, 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 rigestizione di queste chiavi.

IndexerExecutionResult

Rappresenta il risultato di un'esecuzione singola dell'indicizzatore.

Nome	Tipo	Descrizione
currentState	IndexerCurrentState	Tutto lo stato che definisce e determina l'esecuzione corrente dell'indicizzatore.
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	Modificare lo stato di rilevamento con cui è stata completata un'esecuzione dell'indicizzatore.
initialTrackingState	string	Modificare lo stato di rilevamento con cui è stata avviata un'esecuzione dell'indicizzatore.
itemsFailed	integer	Numero di elementi non indicizzati durante l'esecuzione dell'indicizzatore.
itemsProcessed	integer	Numero di elementi elaborati durante l'esecuzione dell'indicizzatore. Ciò include sia elementi elaborati che elementi in cui l'indicizzazione è stata tentata, ma non riuscita.
startTime	string	Ora di inizio dell'esecuzione dell'indicizzatore.
status	IndexerExecutionStatus	Risultato di questa esecuzione dell'indicizzatore.
statusDetail	IndexerExecutionStatusDetail	Risultato di questa 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.

IndexerExecutionStatusDetail

Dettaglia lo stato di un singolo indicizzatore.

Nome	Tipo	Descrizione
resetDocs	string	Indica che la reimpostazione che si è verificata è stata per una chiamata a ResetDocs.

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.

IndexingMode

Rappresenta la modalità in cui viene eseguito l'indicizzatore.

Nome	Tipo	Descrizione
indexingAllDocs	string	L'indicizzatore indicizza tutti i documenti nell'origine dati.
indexingResetDocs	string	L'indicizzatore esegue l'indicizzazione selettiva e reimposta i documenti nell'origine dati. I documenti indicizzati vengono definiti sullo stato dell'indicizzatore.

SearchError

Descrive una condizione di errore per l'API.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
details	SearchError[]	Matrice di dettagli sugli errori specifici che hanno causato l'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	Informazioni aggiuntive dettagliate 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 è stato generato l'errore. Ad esempio, questo potrebbe fare riferimento a una particolare competenza nel set di competenze collegato. Questo potrebbe non essere sempre disponibile.
statusCode	integer	Codice di stato che indica perché l'operazione di indicizzazione non è riuscita. I valori possibili includono: 400 per un documento di input non valido, 404 per il documento non trovato, 409 per un conflitto di versione, 422 quando l'indice non è temporaneamente disponibile o 503 per quando il servizio è troppo occupato.

SearchIndexerLimits

Nome	Tipo	Descrizione
maxDocumentContentCharactersToExtract	number	Numero massimo di caratteri estratti da un documento selezionato per l'indicizzazione.
maxDocumentExtractionSize	number	Dimensioni massime di un documento, in byte, che verranno considerate valide per l'indicizzazione.
maxRunTime	string	Durata massima consentita dall'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	Informazioni aggiuntive dettagliate 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 è stato generato l'avviso. Ad esempio, questo potrebbe fare riferimento a una particolare competenza nel set di competenze collegato. Questo potrebbe non essere sempre disponibile.

Condividi tramite