Indexes - Get Statistics

Service:

Search Service

API Version:

2023-11-01

Gibt Statistiken für den angegebenen Index zurück, einschließlich der Dokumentanzahl und der Speichernutzung.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Die Endpunkt-URL des Suchdiensts.
indexName	path	True	string	Der Name des Indexes, für den Statistiken abgerufen werden sollen.
api-version	query	True	string	Client-API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-request-id		string uuid	Die Verfolgungs-ID, die mit der Anforderung gesendet wurde, um beim Debuggen zu helfen.

Antworten

Name	Typ	Beschreibung
200 OK	GetIndexStatisticsResult
Other Status Codes	SearchError	Fehlerantwort.

Beispiele

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
}

Definitionen

Name	Beschreibung
GetIndexStatisticsResult	Statistiken für einen bestimmten Index. Statistiken werden in regelmäßigen Abständen gesammelt und sind nicht garantiert immer auf dem neuesten Stand.
SearchError	Beschreibt eine Fehlerbedingung für die API.

GetIndexStatisticsResult

Statistiken für einen bestimmten Index. Statistiken werden in regelmäßigen Abständen gesammelt und sind nicht garantiert immer auf dem neuesten Stand.

Name	Typ	Beschreibung
documentCount	integer	Die Anzahl der Dokumente im Index.
storageSize	integer	Die Vom Index verbrauchte Speichermenge in Bytes.
vectorIndexSize	integer	Die Menge an Arbeitsspeicher in Bytes, die von Vektoren im Index verbraucht werden.

SearchError

Beschreibt eine Fehlerbedingung für die API.

Name	Typ	Beschreibung
code	string	Einer von einem serverdefiniertem Satz von Fehlercodes.
details	SearchError[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
message	string	Eine lesbare Darstellung des Fehlers.