Indexes - Get Statistics

Service:

Search Service

API Version:

2023-11-01

Retourneert statistieken voor de opgegeven index, inclusief het aantal documenten en het opslaggebruik.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	De eindpunt-URL van de zoekservice.
indexName	path	True	string	De naam van de index waarvoor statistieken moeten worden opgehaald.
api-version	query	True	string	Client-API-versie.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-request-id		string uuid	De tracerings-id die met de aanvraag is verzonden om te helpen bij foutopsporing.

Antwoorden

Name	Type	Description
200 OK	GetIndexStatisticsResult
Other Status Codes	SearchError	Foutreactie.

Voorbeelden

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
}

Definities

Name	Description
GetIndexStatisticsResult	Statistieken voor een bepaalde index. Statistieken worden periodiek verzameld en zijn niet altijd altijd up-to-date.
SearchError	Beschrijft een foutvoorwaarde voor de API.

GetIndexStatisticsResult

Statistieken voor een bepaalde index. Statistieken worden periodiek verzameld en zijn niet altijd altijd up-to-date.

Name	Type	Description
documentCount	integer	Het aantal documenten in de index.
storageSize	integer	De hoeveelheid opslag in bytes die door de index wordt verbruikt.
vectorIndexSize	integer	De hoeveelheid geheugen in bytes die wordt verbruikt door vectoren in de index.

SearchError

Beschrijft een foutvoorwaarde voor de API.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	SearchError[]	Een matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.
message	string	Een door mensen leesbare weergave van de fout.