Indexes - Get Statistics

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

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

URI-parameters

Name In Vereist Type Description
endpoint
path True

string (uri)

De eindpunt-URL van de zoekservice.

indexName
path True

string

De naam van de index.

api-version
query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name Vereist Type Description
Accept

Accept

De Accepteer kop.

x-ms-client-request-id

string (uuid)

Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.

Antwoorden

Name Type Description
200 OK

GetIndexStatisticsResult

De aanvraag is voltooid.

Other Status Codes

ErrorResponse

Een onverwachte foutreactie.

Beveiliging

api-key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiken

Name Description
https://search.azure.com/.default

Voorbeelden

SearchServiceGetIndexStatistics

Voorbeeldaanvraag

GET https://exampleservice.search.windows.net/indexes('example-index')/search.stats?api-version=2026-04-01

Voorbeeldrespons

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

Definities

Name Description
Accept

De Accepteer kop.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

De foutdetails.

ErrorResponse

Veelvoorkomende foutrespons voor alle Azure Resource Manager API's om foutdetails terug te geven bij mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

GetIndexStatisticsResult

Statistieken voor een bepaalde index. Statistieken worden periodiek verzameld en worden niet gegarandeerd altijd up-to-datum.

Accept

De Accepteer kop.

Waarde Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

De aanvullende informatie.

type

string

Het extra informatietype.

ErrorDetail

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

De fout bevat aanvullende informatie.

code

string

De foutcode.

details

ErrorDetail[]

De foutdetails.

message

string

Het foutbericht.

target

string

Het foutdoelwit.

ErrorResponse

Veelvoorkomende foutrespons voor alle Azure Resource Manager API's om foutdetails terug te geven bij mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

Name Type Description
error

ErrorDetail

Het foutobject.

GetIndexStatisticsResult

Statistieken voor een bepaalde index. Statistieken worden periodiek verzameld en worden niet gegarandeerd altijd up-to-datum.

Name Type Description
documentCount

integer (int64)

Het aantal documenten in de index.

storageSize

integer (int64)

De hoeveelheid opslagruimte in bytes die door de index wordt verbruikt.

vectorIndexSize

integer (int64)

De hoeveelheid geheugen in bytes die wordt verbruikt door vectoren in de index.