Indexers - Get Status

Service:
Search Service
Version d'API:
2025-11-01-preview

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

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

Paramètres URI

Nom Dans Obligatoire Type Description
endpoint
 path True

string (uri)

URL du point de terminaison du service de recherche.
indexerName
 path True

string

Nom de l’indexeur.
api-version
 query True

string

minLength: 1

Version de l’API à utiliser pour cette opération.

En-tête de la demande

Nom Obligatoire Type Description
Accept

Accept

L’en-tête Accept.
x-ms-client-request-id

string (uuid)

Identificateur de chaîne opaque, globalement unique et généré par le client pour la requête.

Réponses

Nom Type Description
200 OK

SearchIndexerStatus

La demande a réussi.
Other Status Codes

ErrorResponse

Réponse d’erreur inattendue.

Sécurité

api-key

Type: apiKey
Dans: header

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Étendues

Nom Description
https://search.azure.com/.default

Exemples

SearchServiceGetIndexerStatus
SearchServiceGetS3HDUnlimitedIndexerStatus

SearchServiceGetIndexerStatus

Exemple de requête

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

Exemple de réponse

Code d’état:
200 
{
  "name": "myindexer",
  "status": "running",
  "runtime": {
    "usedSeconds": 0,
    "beginningTime": "2024-06-06T00:00:00.000Z",
    "endingTime": "2024-06-07T00:00:00.000Z"
  },
  "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": []
  }
}

SearchServiceGetS3HDUnlimitedIndexerStatus

Exemple de requête

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

Exemple de réponse

Code d’état:
200 
{
  "name": "myindexer",
  "status": "running",
  "runtime": {
    "usedSeconds": 0,
    "remainingSeconds": 39600,
    "beginningTime": "2024-06-06T00:00:00.000Z",
    "endingTime": "2024-06-07T00:00:00.000Z"
  },
  "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
Accept

L’en-tête Accept.
ErrorAdditionalInfo

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

Détail de l’erreur.
ErrorResponse

Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).
IndexerCurrentState

Représente tout l’état qui définit et détermine l’exécution actuelle de l’indexeur.
IndexerExecutionResult

Représente le résultat d’une exécution d’indexeur individuelle.
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.
IndexerRuntime

Représente la consommation cumulative d’exécution de l’indexeur dans le service.
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

Représente les limites pouvant être appliquées à un indexeur.
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.

Accept

Énumération

L’en-tête Accept.

Valeur Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Objet

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

Nom Type Description
info

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 courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).

Nom Type Description
error

ErrorDetail

Objet d’erreur.

IndexerCurrentState

Objet

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

Nom Type Description
allDocsFinalTrackingState

string

Valeur d’état de suivi des modifications lorsque l’indexation se termine sur tous les documents de la source de données.
allDocsInitialTrackingState

string

État de suivi des modifications utilisé lors de l’indexation sur tous les documents de la source de données.
mode

IndexingMode

Mode dans lequel l’indexeur est en cours d’exécution.
resetDatasourceDocumentIds

string[]

Liste des ID de document de source de données qui ont été réinitialisés. L’ID de document de source de données est l’identificateur unique des données dans la source de données. L’indexeur hiérarchise de manière sélective ces ID.
resetDocsFinalTrackingState

string

Valeur d’état de suivi des modifications lors de l’indexation terminée lors de la sélection, réinitialisez les documents dans la source de données.
resetDocsInitialTrackingState

string

État de suivi des modifications utilisé lors de l’indexation lors de la sélection, réinitialisez les documents dans la source de données.
resetDocumentKeys

string[]

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 hiérarchise de façon sélective la régestion 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 d’une exécution d’indexeur individuelle.

Nom Type Description
endTime

string (date-time)

Heure de fin de cette exécution de l’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

État de suivi des modifications avec lequel une exécution de l’indexeur s’est terminée.
initialTrackingState

string

État de suivi des modifications avec lequel une exécution d’indexeur a démarré.
itemsFailed

integer (int32)

Nombre d’éléments qui n’ont pas pu être indexés pendant l’exécution de cet indexeur.
itemsProcessed

integer (int32)

Nombre d’éléments qui ont été traités pendant cette exécution de l’indexeur. Cela inclut les éléments traités avec succès et les éléments où l’indexation a été tentée, mais a échoué.
mode

IndexingMode

Mode dans lequel l’indexeur est en cours d’exécution.
startTime

string (date-time)

Heure de début de cette exécution de l’indexeur.
status

IndexerExecutionStatus

Résultat de cette exécution de l’indexeur.
statusDetail

IndexerExecutionStatusDetail

Résultat de cette exécution de l’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 était pour un appel à ResetDocs.
resync

Indique la resynchronisation sélective en fonction des options de la source de données.

IndexerRuntime

Objet

Représente la consommation cumulative d’exécution de l’indexeur dans le service.

Nom Type Description
beginningTime

string (date-time)

Heure UTC de début de la période de 24 heures prise en compte pour l’utilisation de l’exécution de l’indexeur (incluse).
endingTime

string (date-time)

Heure UTC de fin de la période de 24 heures prise en compte pour l’utilisation du runtime de l’indexeur (inclus).
remainingSeconds

integer (int64)

Temps d’exécution cumulatif restant pour tous les indexeurs du service de beginningTime à endTime, en secondes.
usedSeconds

integer (int64)

Temps d’exécution cumulé de l’indexeur du débutTemps à la finTemps, en secondes.

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 dans la source de données.
indexingResetDocs

L’indexeur indexeur indexe des documents sélectifs et réinitialisés dans la source de données. Les documents indexés sont définis sur l’état 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

Représente les limites pouvant être appliquées à un indexeur.

Nom Type Description
maxDocumentContentCharactersToExtract

integer (int64)

Nombre maximal de caractères extraits d’un document sélectionné pour l’indexation.
maxDocumentExtractionSize

integer (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ées dans l’ordre chronologique inverse.
lastResult

IndexerExecutionResult

Résultat de l’exécution de l’indexeur le plus récent ou en cours.
limits

SearchIndexerLimits

Limites d’exécution pour l’indexeur.
name

string

Nom de l’indexeur.
runtime

IndexerRuntime

Instantané de la consommation cumulative d’exécution de l’indexeur pour le service sur la période UTC actuelle.
status

IndexerStatus

État global 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.