Indexes - Get Statistics

Služba:: Search Service

Verze rozhraní API:: 2025-11-01-preview

Vrací statistiky pro daný index, včetně počtu dokumentů a využití úložiště.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string (uri)	Adresa URL koncového bodu vyhledávací služby.
indexName	path	True	string	Název indexu.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Accept		Accept	Hlavička Accept.
x-ms-client-request-id		string (uuid)	Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Odpovědi

Name	Typ	Description
200 OK	GetIndexStatisticsResult	Požadavek byl úspěšný.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

api-key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Rozsahy

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

Příklady

SearchServiceGetIndexStatistics

Ukázkový požadavek

HTTP

GET https://previewexampleservice.search.windows.net/indexes('preview-test')/search.stats?api-version=2025-11-01-preview

Ukázková odpověď

Stavový kód:: 200

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

Definice

Name	Description
Accept	Hlavička Accept.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)
GetIndexStatisticsResult	Statistika pro daný index Statistiky se shromažďují pravidelně a není zaručeno, že budou vždy up-to-date.

Accept

Výčet

Hlavička Accept.

Hodnota	Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info		Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

GetIndexStatisticsResult

Objekt

Statistika pro daný index Statistiky se shromažďují pravidelně a není zaručeno, že budou vždy up-to-date.

Name	Typ	Description
documentCount	integer (int64)	Počet dokumentů v rejstříku.
storageSize	integer (int64)	Velikost úložiště v bajtech spotřebovaných indexem.
vectorIndexSize	integer (int64)	Velikost paměti v bajtech spotřebovaná vektory v indexu.