Indexers - Get Status

Référence

Service:: Search Service

Version d'API:: 2023-10-01-Preview

Renvoie le statut actuel et l'historique d'exécution d'un indexeur.

GET {endpoint}/indexers('{indexerName}')/search.status?api-version=2023-10-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	Le nom de l'indexeur dont l'état doit être récupéré.
api-version	query	True	string	Version de l’API cliente.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-request-id		string uuid	ID de suivi envoyé avec la demande d’aide pour le débogage.

Réponses

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

Exemples

SearchServiceGetIndexerStatus

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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
  }
}

Définitions

Nom	Description
IndexerCurrentState	Représente tout l’état qui définit et dicte l’exécution actuelle de l’indexeur.
IndexerExecutionResult	Représente le résultat d’une exécution d’indexeur individuel.
IndexerExecutionStatus	Représente l'état d'exécution d'un indexeur individuel.
IndexerExecutionStatusDetail	Détaille les status d’une exécution d’indexeur individuel.
IndexerStatus	Représente l'état global de l'indexeur.
IndexingMode	Représente le mode dans lequel l’indexeur s’exécute.
SearchError	Décrit une condition d’erreur pour l’API.
SearchIndexerError	Représente une erreur d'indexation de niveau élément ou document.
SearchIndexerLimits
SearchIndexerStatus	Represente le statut actuel et l'historique d'exécution d'un indexeur.
SearchIndexerWarning	Représente un avertissement au niveau de l’élément.

IndexerCurrentState

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

Nom	Type	Description
allDocsFinalChangeTrackingState	string	Valeur de l’état de suivi des modifications lorsque l’indexation se termine sur tous les documents de la source de données.
allDocsInitialChangeTrackingState	string	État de suivi des modifications utilisé lors du démarrage de l’indexation sur tous les documents de la source de données.
mode	IndexingMode	Mode dans lequel l’indexeur s’exécute.
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 la réingestion sélective de ces ID.
resetDocsFinalChangeTrackingState	string	Valeur d’état de suivi des modifications lorsque l’indexation se termine lors de la sélection, réinitialisez les documents dans la source de données.
resetDocsInitialChangeTrackingState	string	État de suivi des modifications utilisé lors du démarrage 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 la réingestion sélective de ces clés.

IndexerExecutionResult

Représente le résultat d’une exécution d’indexeur individuel.

Nom	Type	Description
currentState	IndexerCurrentState	Tout l’état qui définit et dicte l’exécution actuelle de l’indexeur.
endTime	string	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 l’exécution d’un indexeur s’est terminée.
initialTrackingState	string	État de suivi des modifications avec lequel l’exécution d’un indexeur a démarré.
itemsFailed	integer	Nombre d’éléments qui n’ont pas pu être indexés pendant cette exécution de l’indexeur.
itemsProcessed	integer	Nombre d’éléments qui ont été traités pendant cette exécution de l’indexeur. Cela inclut à la fois les éléments traités avec succès et les éléments pour lesquels l’indexation a été tentée mais a échoué.
startTime	string	Heure de début de l’exécution de cet 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

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

Nom	Type	Description
inProgress	string	L'exécution de l'indexeur est en cours.
reset	string	L'indexeur a été réinitialisé.
success	string	L'exécution de l'indexeur est complétée avec succès.
transientFailure	string	Un appel de l'indexeur a échoué, mais l'échec peut être transitoire. Les appels de l'indexeur continuent par la planification.

IndexerExecutionStatusDetail

Détaille les status d’une exécution d’indexeur individuel.

Nom	Type	Description
resetDocs	string	Indique que la réinitialisation qui s’est produite concerne un appel à ResetDocs.

IndexerStatus

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

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

IndexingMode

Représente le mode dans lequel l’indexeur s’exécute.

Nom	Type	Description
indexingAllDocs	string	L’indexeur indexe tous les documents dans la source de données.
indexingResetDocs	string	L’indexeur indexe des documents sélectifs et réinitialise les documents dans la source de données. Les documents indexés sont définis sur l’indexeur status.

SearchError

Décrit une condition d’erreur pour l’API.

Nom	Type	Description
code	string	Un des codes d’erreur définis par le serveur.
details	SearchError[]	Tableau de détails sur les erreurs spécifiques qui ont conduit à cette erreur signalée.
message	string	Représentation lisible par l’homme de l’erreur.

SearchIndexerError

Représente une erreur d'indexation de niveau élément ou document.

Nom	Type	Description
details	string	Des détails supplémentaires détaillés sur l’erreur pour faciliter le débogage de l’indexeur. Cela n’est peut-être pas toujours disponible.
documentationLink	string	Lien vers un guide de résolution des problèmes pour ces classes d’erreurs. Cela n’est peut-être pas toujours disponible.
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 pour lequel l’indexation a échoué.
name	string	Nom de la source à l’origine de l’erreur. Par exemple, cela peut faire référence à une compétence particulière dans l’ensemble de compétences attaché. Cela n’est peut-être pas toujours disponible.
statusCode	integer	Le code status indiquant pourquoi l’opération d’indexation a échoué. 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

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

SearchIndexerStatus

Represente le statut actuel et l'historique d'exécution d'un indexeur.

Nom	Type	Description
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 de l’indexeur la plus récente ou en cours.
limits	SearchIndexerLimits	Limites d’exécution de l’indexeur.
status	IndexerStatus	Statut global de l'indexation.

SearchIndexerWarning

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

Nom	Type	Description
details	string	Des détails supplémentaires détaillés sur l’avertissement pour faciliter le débogage de l’indexeur. Cela n’est peut-être pas toujours disponible.
documentationLink	string	Lien vers un guide de résolution des problèmes pour ces classes d’avertissements. Cela n’est peut-être pas toujours disponible.
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’origine de l’avertissement. Par exemple, cela peut faire référence à une compétence particulière dans l’ensemble de compétences attaché. Cela n’est peut-être pas toujours disponible.

Partager via