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-08-01-preview

URI-parameters

Naam 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

Naam Vereist Type Description
x-ms-client-request-id

string (uuid)

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

Accept

Accept

De Accepteer kop.

Antwoorden

Naam 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

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

Voorbeelden

SearchServiceGetIndexStatistics

Voorbeeldaanvraag

GET https://typespecpreviewexampleservice.search.windows.net/indexes('preview-test')/search.stats?api-version=2026-08-01-preview


Voorbeeldrespons

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

Definities

Naam Description
Accept

De Accepteer kop.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

Het foutdetail.

ErrorResponse

Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor 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.

Naam Type Description
info

De aanvullende informatie.

type

string

Het extra informatietype.

ErrorDetail

Het foutdetail.

Naam Type Description
additionalInfo

ErrorAdditionalInfo[]

Aanvullende informatie over de fout.

code

string

De foutcode.

details

ErrorDetail[]

De foutgegevens.

message

string

Het foutbericht.

target

string

Het foutdoelwit.

ErrorResponse

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

Naam Type Description
error

ErrorDetail

Het foutobject.

GetIndexStatisticsResult

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

Naam 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.