Indexes - Get Statistics

Service:: Search Service

Version d’API:: 2026-08-01-preview

Renvoie des statistiques pour l’index donné, y compris le nombre de documents et l’utilisation du stockage.

GET {endpoint}/indexes('{indexName}')/search.stats?api-version=2026-08-01-preview

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (uri)	URL du point de terminaison du service de recherche.
indexName	path	True	string	Nom de l’index.
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	GetIndexStatisticsResult	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

SearchServiceGetIndexStatistics

Exemple de requête

HTTP

GET https://typespecpreviewexampleservice.search.windows.net/indexes('preview-test')/search.stats?api-version=2026-08-01-preview

Exemple de réponse

Code d’état:: 200

{
  "documentCount": 12,
  "storageSize": 123456,
  "vectorIndexSize": 123456
}

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.).
GetIndexStatisticsResult	Statistiques d’un index donné. Les statistiques sont collectées régulièrement et ne sont pas garanties d’être toujours up-to-date.

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	Le type d’informations supplémentaires.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations complé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.

GetIndexStatisticsResult

Objet

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.
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 les vecteurs dans l’index.