Get Index Stats Summary - Get Index Stats Summary

Service:

Search Service

Version d'API:

2025-05-01-preview

Récupère un résumé des statistiques pour tous les index du service de recherche.

GET {endpoint}/indexstats?api-version=2025-05-01-preview

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string	URL du point de terminaison du service de recherche.
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	ListIndexStatsSummary	Résumé des statistiques pour tous les index.
Other Status Codes	ErrorResponse	Réponse d’erreur.

Exemples

SearchServiceIndexStatsSummary

Exemple de requête

HTTP

GET https://previewexampleservice.search.windows.net/indexstats?api-version=2025-05-01-preview

Exemple de réponse

Code d’état:

200

{
  "value": [
    {
      "name": "preview-test",
      "documentCount": 0,
      "storageSize": 0,
      "vectorIndexSize": 0
    }
  ]
}

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
IndexStatisticsSummary	Statistiques d’un index donné. Les statistiques sont collectées régulièrement et ne sont pas garanties d’être toujours up-to-date.
ListIndexStatsSummary	Réponse d’une demande pour récupérer le résumé des statistiques de tous les index. Si elle réussit, elle inclut les statistiques de chaque index dans le service.

ErrorAdditionalInfo

Object

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

Object

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

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

IndexStatisticsSummary

Object

Statistiques d’un index donné. Les statistiques sont collectées régulièrement et ne sont pas garanties d’être toujours up-to-date.

Nom	Type	Description
documentCount	integer (int64)	Nombre de documents dans l’index.
name	string	Nom de l’index.
storageSize	integer (int64)	Quantité de stockage en octets consommée par l’index.
vectorIndexSize	integer (int64)	Quantité de mémoire en octets consommée par des vecteurs dans l’index.

ListIndexStatsSummary

Object

Réponse d’une demande pour récupérer le résumé des statistiques de tous les index. Si elle réussit, elle inclut les statistiques de chaque index dans le service.

Nom	Type	Description
value	IndexStatisticsSummary[]	Résumé des statistiques de tous les index dans le service de recherche.