Indexes - Get Statistics

Service:

Search Service

API Version:

2023-11-01

Returnerar statistik för det angivna indexet, inklusive ett antal dokument och lagringsanvändning.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Slutpunkts-URL:en för söktjänsten.
indexName	path	True	string	Namnet på indexet som statistik ska hämtas för.
api-version	query	True	string	Klient-API-version.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string uuid	Spårnings-ID:t som skickas med begäran för att hjälpa till med felsökning.

Svar

Name	Typ	Description
200 OK	GetIndexStatisticsResult
Other Status Codes	SearchError	Felsvar.

Exempel

SearchServiceGetIndexStatistics

Sample Request

HTTP

GET https://myservice.search.windows.net/indexes('hotels')/search.stats?api-version=2023-11-01

Sample Response

Status code:

200

{
  "documentCount": 239572,
  "storageSize": 72375920,
  "vectorIndexSize": 123456
}

Definitioner

Name	Description
GetIndexStatisticsResult	Statistik för ett visst index. Statistik samlas in regelbundet och garanteras inte alltid vara uppdaterad.
SearchError	Beskriver ett felvillkor för API:et.

GetIndexStatisticsResult

Statistik för ett visst index. Statistik samlas in regelbundet och garanteras inte alltid vara uppdaterad.

Name	Typ	Description
documentCount	integer	Antalet dokument i indexet.
storageSize	integer	Mängden lagringsutrymme i byte som förbrukas av indexet.
vectorIndexSize	integer	Mängden minne i byte som förbrukas av vektorer i indexet.

SearchError

Beskriver ett felvillkor för API:et.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	SearchError[]	En matris med information om specifika fel som ledde till det rapporterade felet.
message	string	En mänsklig läsbar representation av felet.