Indexes - Get Statistics

Zwraca statystyki dla danego indeksu, w tym liczbę dokumentów i użycie magazynu.

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

Parametry identyfikatora URI

Nazwisko W Wymagane Typ Opis
endpoint
path True

string (uri)

Adres URL punktu końcowego usługi wyszukiwania.

indexName
path True

string

Nazwa indeksu.

api-version
query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwisko Wymagane Typ Opis
x-ms-client-request-id

string (uuid)

Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Accept

Accept

Nagłówek „Accept”.

Odpowiedzi

Nazwisko Typ Opis
200 OK

GetIndexStatisticsResult

Żądanie zakończyło się pomyślnie.

Other Status Codes

ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

api-key

Typ: apiKey
W: header

OAuth2Auth

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Zakresy

Nazwisko Opis
https://search.azure.com/.default

Przykłady

SearchServiceGetIndexStatistics

Przykładowe żądanie

GET https://typespecstableexampleservice.search.windows.net/indexes('stable-test')/search.stats?api-version=2026-10-01


Przykładowa odpowiedź

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

Definicje

Nazwisko Opis
Accept

Nagłówek „Accept”.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

ErrorDetail

Szczegóły błędu.

ErrorResponse

Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

GetIndexStatisticsResult

Statystyki dla danego indeksu. Statystyki są zbierane okresowo i nie mają gwarancji, że zawsze będą up-to-date.

Accept

Nagłówek „Accept”.

Wartość Opis
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwisko Typ Opis
info

Dodatkowe informacje.

type

string

Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwisko Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie

code

string

Kod błędu.

details

ErrorDetail[]

Szczegóły błędu.

message

string

Komunikat o błędzie.

target

string

Cel błędu.

ErrorResponse

Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

Nazwisko Typ Opis
error

ErrorDetail

Obiekt błędu.

GetIndexStatisticsResult

Statystyki dla danego indeksu. Statystyki są zbierane okresowo i nie mają gwarancji, że zawsze będą up-to-date.

Nazwisko Typ Opis
documentCount

integer (int64)

Liczba dokumentów w indeksie.

storageSize

integer (int64)

Ilość miejsca do magazynowania w bajtach zajmowanych przez indeks.

vectorIndexSize

integer (int64)

Ilość pamięci (w bajtach) zajmowana przez wektory w indeksie.