Indexes - Get Statistics

Szolgáltatás:
Search Service
API-verzió:
2023-11-01

Az adott index statisztikáit adja vissza, beleértve a dokumentumok számát és a tárterület használatát.

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

URI-paraméterek

Name In Kötelező Típus Description
endpoint
 path True

string

A keresési szolgáltatás végponti URL-címe.
indexName
 path True

string

Annak az indexnek a neve, amelyhez statisztikákat szeretne lekérni.
api-version
 query True

string

Ügyfél API-verziója.

Kérelem fejléce

Name Kötelező Típus Description
x-ms-client-request-id

string (uuid)

A kéréssel együtt küldött nyomkövetési azonosító, amely segít a hibakeresésben.

Válaszok

Name Típus Description
200 OK

GetIndexStatisticsResult

Other Status Codes

SearchError

Hibaválasz.

Példák

SearchServiceGetIndexStatistics

Mintakérelem

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

Mintaválasz

Állapotkód:
200 
{
  "documentCount": 239572,
  "storageSize": 72375920,
  "vectorIndexSize": 123456
}

Definíciók

Name Description
GetIndexStatisticsResult

Egy adott index statisztikái. A statisztikák rendszeres gyűjtése nem garantált, hogy mindig up-todátum.
SearchError

Az API hibafeltételét ismerteti.

GetIndexStatisticsResult

Tárgy

Egy adott index statisztikái. A statisztikák rendszeres gyűjtése nem garantált, hogy mindig up-todátum.

Name Típus Description
documentCount

integer (int64)

Az indexben lévő dokumentumok száma.
storageSize

integer (int64)

Az index által felhasznált bájtokban lévő tárterület mennyisége.
vectorIndexSize

integer (int64)

Az index vektorai által felhasznált memória mennyisége bájtban.

SearchError

Tárgy

Az API hibafeltételét ismerteti.

Name Típus Description
code

string

A kiszolgáló által definiált hibakódok egyike.
details

SearchError[]

A jelentett hibához vezető konkrét hibák részleteinek tömbje.
message

string

A hiba ember által olvasható ábrázolása.