Indexers - Get Status

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

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
path True

string (uri)

URL dell'endpoint del servizio di ricerca.

indexerName
path True

string

Nome dell'indicizzatore.

api-version
query True

string

minLength: 1

Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome Necessario Tipo Descrizione
Accept

Accept

L'intestazione Accetta.

x-ms-client-request-id

string (uuid)

Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta.

Risposte

Nome Tipo Descrizione
200 OK

SearchIndexerStatus

La richiesta ha avuto esito positivo.

Other Status Codes

ErrorResponse

Risposta di errore imprevista.

Sicurezza

api-key

Tipo: apiKey
In: header

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ambiti

Nome Descrizione
https://search.azure.com/.default

Esempio

SearchServiceGetIndexerStatus
SearchServiceGetS3HDUnlimitedIndexerStatus

SearchServiceGetIndexerStatus

Esempio di richiesta

GET https://exampleservice.search.windows.net/indexers('myindexer')/search.status?api-version=2026-04-01

Risposta di esempio

{
  "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,
    "errors": [],
    "warnings": []
  },
  "executionHistory": [
    {
      "status": "success",
      "startTime": "2014-11-26T03:37:18.853Z",
      "endTime": "2014-11-26T03:37:19.012Z",
      "itemsProcessed": 11,
      "itemsFailed": 0,
      "errors": [],
      "warnings": []
    },
    {
      "status": "transientFailure",
      "startTime": "2014-11-26T03:28:10.125Z",
      "endTime": "2014-11-26T03:28:12.007Z",
      "itemsProcessed": 1,
      "itemsFailed": 2,
      "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
  }
}

SearchServiceGetS3HDUnlimitedIndexerStatus

Esempio di richiesta

GET https://exampleservice.search.windows.net/indexers('myindexer')/search.status?api-version=2026-04-01

Risposta di esempio

{
  "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,
    "errors": [],
    "warnings": []
  },
  "executionHistory": [
    {
      "status": "success",
      "startTime": "2014-11-26T03:37:18.853Z",
      "endTime": "2014-11-26T03:37:19.012Z",
      "itemsProcessed": 11,
      "itemsFailed": 0,
      "errors": [],
      "warnings": []
    },
    {
      "status": "transientFailure",
      "startTime": "2014-11-26T03:28:10.125Z",
      "endTime": "2014-11-26T03:28:12.007Z",
      "itemsProcessed": 1,
      "itemsFailed": 2,
      "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
  }
}

Definizioni

Nome Descrizione
Accept

L'intestazione Accetta.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

ErrorDetail

Dettagli dell'errore.

ErrorResponse

Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.

IndexerExecutionResult

Rappresenta il risultato di una singola esecuzione dell'indicizzatore.

IndexerExecutionStatus

Rappresenta lo stato di una singola esecuzione dell'indicizzatore.

IndexerStatus

Rappresenta lo stato generale dell'indicizzatore.

SearchIndexerError

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

SearchIndexerLimits

Rappresenta i limiti che possono essere applicati a un indicizzatore.

SearchIndexerStatus

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

SearchIndexerWarning

Rappresenta un avviso a livello di elemento.

Accept

L'intestazione Accetta.

Valore Descrizione
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

Informazioni aggiuntive.

type

string

Tipo di informazioni aggiuntive.

ErrorDetail

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

Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.

IndexerExecutionResult

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.

startTime

string (date-time)

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.

Valore Descrizione
transientFailure

Una chiamata all'indicizzatore non è riuscita, ma l'errore potrebbe essere temporaneo. Le chiamate all'indicizzatore continueranno in base alla pianificazione.

success

L'esecuzione dell'indicizzatore è stata completata correttamente.

inProgress

L'esecuzione dell'indicizzatore è in corso.

reset

L'indicizzatore è stato reimpostato.

IndexerStatus

Rappresenta lo stato generale dell'indicizzatore.

Valore Descrizione
unknown

Indica che l'indicizzatore si trova in uno stato sconosciuto.

error

Indica che l'indicizzatore ha riscontrato un errore che non può essere corretto senza l'intervento umano.

running

Indica che l'indicizzatore è in esecuzione normalmente.

SearchIndexerError

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

Rappresenta i limiti che possono essere applicati a un indicizzatore.

Nome Tipo Descrizione
maxDocumentContentCharactersToExtract

integer (int64)

Numero massimo di caratteri che verranno estratti da un documento prelevato per l'indicizzazione.

maxDocumentExtractionSize

integer (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

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.

name

string

Nome dell'indicizzatore.

status

IndexerStatus

Stato complessivo dell'indicizzatore.

SearchIndexerWarning

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.