Indexers - Get Status

Référence

Service:: Search Service

Version d'API:: 2024-07-01

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

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

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 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 pour faciliter le 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://myservice.search.windows.net/indexers('myindexer')/search.status?api-version=2024-07-01

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
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
IndexerExecutionResult	Représente le résultat d’une exécution d’indexeur individuelle.
IndexerExecutionStatus	Représente l’état d’une exécution d’indexeur individuelle.
IndexerStatus	Représente l’état global 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

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

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

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

IndexerExecutionResult

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

Nom	Type	Description
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 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	Nombre d’éléments qui n’ont pas pu être indexés pendant l’exécution de cet indexeur.
itemsProcessed	integer	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é.
startTime	string	Heure de début de cette exécution de l’indexeur.
status	IndexerExecutionStatus	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’une exécution d’indexeur individuelle.

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 s’est terminée avec succès.
transientFailure	string	Un appel d’indexeur a échoué, mais l’échec peut être temporaire. Les appels d’indexeur continuent par planification.

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.

SearchIndexerError

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

Nom	Type	Description
details	string	En outre, des détails détaillés sur l’erreur pour faciliter le débogage de l’indexeur. Cela peut ne pas être toujours disponible.
documentationLink	string	Lien vers un guide de résolution des problèmes pour ces classes d’erreurs. Cela peut ne pas être 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 à laquelle l’erreur provient. Par exemple, cela peut faire référence à une compétence particulière dans l’ensemble de compétences attaché. Cela peut ne pas être toujours disponible.
statusCode	integer	Code d’état 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 le document introuvable, 409 pour un conflit de version, 422 lorsque l’index est temporairement indisponible ou 503 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 pendant laquelle l’indexeur est autorisé à s’exécuter pour une exécution.

SearchIndexerStatus

Représente l’état 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é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.
status	IndexerStatus	État global de l’indexeur.

SearchIndexerWarning

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

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

Partager via