Indexes - Get Statistics

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

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

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 Tracking-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

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
GetIndexStatisticsResult

Statistiken für einen bestimmten Index. Statistiken werden regelmäßig gesammelt und sind nicht garantiert immer up-to-datum.

SearchError

Beschreibt eine Fehlerbedingung für die API.

GetIndexStatisticsResult

Statistiken für einen bestimmten Index. Statistiken werden regelmäßig gesammelt und sind nicht garantiert immer up-to-datum.

Name Typ Beschreibung
documentCount

integer (int64)

Die Anzahl der Dokumente im Index.

storageSize

integer (int64)

Die Vom Index verbrauchte Speichermenge in Bytes.

vectorIndexSize

integer (int64)

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

Eine serverdefinierte Gruppe 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.