Indexers - Get Status

Service:: Search Service

Version d'API:: 2025-08-01-preview

Renvoie l’état actuel et l’historique d’exécution d’un indexeur.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string	URL du point de terminaison du service de recherche.
indexerName	path	True	string	Nom de l’indexeur pour lequel récupérer l’état.
api-version	query	True	string	Version de l’API client.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-request-id		string (uuid)	ID de suivi envoyé avec la demande pour aider au débogage.

Réponses

Nom	Type	Description
200 OK	SearchIndexerStatus
Other Status Codes	ErrorResponse	Réponse d’erreur.

Exemples

SearchServiceGetIndexerStatus

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

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

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
IndexerCurrentState	Représente l’ensemble de l’état qui définit et dicte l’exécution actuelle de l’indexeur.
IndexerExecutionResult	Représente le résultat de l’exécution d’un indexeur individuel.
IndexerExecutionStatus	Représente l’état de l’exécution d’un indexeur individuel.
IndexerExecutionStatusDetail	Détaille l’état de l’exécution d’un indexeur individuel.
IndexerStatus	Représente l’état global de l’indexeur.
IndexingMode	Représente le mode d’exécution de l’indexeur.
SearchIndexerError	Représente une erreur d’indexation au niveau de l’élément ou du document.
SearchIndexerLimits
SearchIndexerStatus	Représente l’état actuel et l’historique d’exécution d’un indexeur.
SearchIndexerWarning	Représente un avertissement au niveau de l’élément.

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

IndexerCurrentState

Objet

Représente l’ensemble de l’état qui définit et dicte l’exécution actuelle de l’indexeur.

Nom	Type	Description
allDocsFinalTrackingState	string	Modifiez la valeur de l’état de suivi à la fin de l’indexation sur tous les documents de la source de données.
allDocsInitialTrackingState	string	Modifier l’état de suivi utilisé au démarrage de l’indexation sur tous les documents de la source de données.
mode	IndexingMode	Mode d’exécution de l’indexeur.
resetDatasourceDocumentIds	string[]	Liste des ID de document de source de données qui ont été réinitialisés. L’ID de document de la source de données est l’identificateur unique des données de la source de données. L’indexeur donnera la priorité à la réingestion sélective de ces ids.
resetDocsFinalTrackingState	string	Modifiez la valeur de l’état de suivi à la fin de l’indexation lors de la sélection, réinitialisez les documents dans la source de données.
resetDocsInitialTrackingState	string	Modifier l’état de suivi utilisé lorsque l’indexation démarre lors de la sélection et de la réinitialisation des documents dans la source de données.
resetDocumentKeys	string[]	La liste des clés de document qui ont été réinitialisées. La clé de document est l’identificateur unique du document pour les données de l’index de recherche. L’indexeur donnera la priorité à la réingestion sélective de ces clés.
resyncFinalTrackingState	string	Modifiez la valeur de l’état de suivi à la fin de l’indexation sur les options sélectives de la source de données.
resyncInitialTrackingState	string	Modifier l’état de suivi utilisé lorsque l’indexation démarre sur des options sélectives de la source de données.

IndexerExecutionResult

Objet

Représente le résultat de l’exécution d’un indexeur individuel.

Nom	Type	Description
endTime	string (date-time)	Heure de fin de l’exécution de cet indexeur, si l’exécution est déjà terminée.
errorMessage	string	Message d’erreur indiquant l’erreur de niveau supérieur, le cas échéant.
errors	SearchIndexerError[]	Erreurs d’indexation au niveau de l’élément.
finalTrackingState	string	Modifiez l’état de suivi avec lequel l’exécution d’un indexeur s’est terminée.
initialTrackingState	string	Modifiez l’état de suivi avec lequel l’exécution d’un indexeur a démarré.
itemsFailed	integer (int32)	Nombre d’éléments qui n’ont pas pu être indexés lors de l’exécution de cet indexeur.
itemsProcessed	integer (int32)	Nombre d’éléments qui ont été traités lors de l’exécution de cet indexeur. Cela inclut à la fois les éléments traités avec succès et les éléments dont l’indexation a été tentée mais a échoué.
mode	IndexingMode	Mode d’exécution de l’indexeur.
startTime	string (date-time)	Heure de début de l’exécution de cet indexeur.
status	IndexerExecutionStatus	Le résultat de l’exécution de cet indexeur.
statusDetail	IndexerExecutionStatusDetail	Le résultat de l’exécution de cet indexeur.
warnings	SearchIndexerWarning[]	Avertissements d’indexation au niveau de l’élément.

IndexerExecutionStatus

Énumération

Représente l’état de l’exécution d’un indexeur individuel.

Valeur	Description
transientFailure	L’appel d’un indexeur a échoué, mais il peut s’agir d’un échec. Les appels de l’indexeur se poursuivront selon la planification.
success	L’exécution de l’indexeur s’est terminée avec succès.
inProgress	L’exécution de l’indexeur est en cours.
reset	L’indexeur a été réinitialisé.

IndexerExecutionStatusDetail

Énumération

Détaille l’état de l’exécution d’un indexeur individuel.

Valeur	Description
resetDocs	Indique que la réinitialisation qui s’est produite concernait un appel à ResetDocs.
resync	Indique la resynchronisation sélective en fonction des options de la source de données.

IndexerStatus

Énumération

Représente l’état global de l’indexeur.

Valeur	Description
unknown	Indique que l’indexeur est dans un état inconnu.
error	Indique que l’indexeur a rencontré une erreur qui ne peut pas être corrigée sans intervention humaine.
running	Indique que l’indexeur s’exécute normalement.

IndexingMode

Énumération

Représente le mode d’exécution de l’indexeur.

Valeur	Description
indexingAllDocs	L’indexeur indexe tous les documents de la source de données.
indexingResetDocs	L’indexeur indexe des documents sélectifs et réinitialisés dans la source de données. Les documents indexés sont définis en fonction du statut de l’indexeur.
indexingResync	L’indexeur resynchronise et indexe les options sélectives de la source de données.

SearchIndexerError

Objet

Représente une erreur d’indexation au niveau de l’élément ou du document.

Nom	Type	Description
details	string	Des détails supplémentaires et détaillés sur l’erreur pour faciliter le débogage de l’indexeur. Ce n’est pas toujours le cas.
documentationLink	string	Un lien vers un guide de dépannage pour ces classes d’erreurs. Ce n’est pas toujours le cas.
errorMessage	string	Message décrivant l’erreur qui s’est produite lors du traitement de l’élément.
key	string	Clé de l’élément dont l’indexation a échoué.
name	string	Nom de la source d’origine de l’erreur. Par exemple, il peut s’agir d’une compétence particulière dans l’ensemble de compétences ci-joint. Ce n’est pas toujours le cas.
statusCode	integer (int32)	Code d’état indiquant la raison de l’échec de l’opération d’indexation. Les valeurs possibles sont les suivantes : 400 pour un document d’entrée mal formé, 404 pour un document introuvable, 409 pour un conflit de version, 422 lorsque l’index est temporairement indisponible ou 503 pour lorsque le service est trop occupé.

SearchIndexerLimits

Objet

Nom	Type	Description
maxDocumentContentCharactersToExtract	number (int64)	Nombre maximal de caractères extraits d’un document sélectionné pour l’indexation.
maxDocumentExtractionSize	number (int64)	Taille maximale d’un document, en octets, qui sera considérée comme valide pour l’indexation.
maxRunTime	string (duration)	Durée maximale pendant laquelle l’indexeur est autorisé à s’exécuter pour une exécution.

SearchIndexerStatus

Objet

Représente l’état actuel et l’historique d’exécution d’un indexeur.

Nom	Type	Description
currentState	IndexerCurrentState	Ensemble de l’état qui définit et dicte l’exécution actuelle de l’indexeur.
executionHistory	IndexerExecutionResult[]	Historique des exécutions récentes de l’indexeur, trié dans l’ordre chronologique inverse.
lastResult	IndexerExecutionResult	Résultat de l’exécution la plus récente ou d’une exécution d’indexeur en cours.
limits	SearchIndexerLimits	Limites d’exécution de l’indexeur.
name	string	Nom de l’indexeur.
status	IndexerStatus	État général de l’indexeur.

SearchIndexerWarning

Objet

Représente un avertissement au niveau de l’élément.

Nom	Type	Description
details	string	Des détails supplémentaires et détaillés sur l’avertissement pour faciliter le débogage de l’indexeur. Ce n’est pas toujours le cas.
documentationLink	string	Un lien vers un guide de dépannage pour ces classes d’avertissements. Ce n’est pas toujours le cas.
key	string	Clé de l’élément qui a généré un avertissement.
message	string	Message décrivant l’avertissement qui s’est produit lors du traitement de l’élément.
name	string	Nom de la source d’où provient l’avertissement. Par exemple, il peut s’agir d’une compétence particulière dans l’ensemble de compétences ci-joint. Ce n’est pas toujours le cas.