Documents - Count

Fragt die Anzahl der Dokumente im Index ab.

GET {endpoint}/indexes('{indexName}')/docs/$count?api-version=2026-11-01-preview

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
path True

string (uri)

Die Endpunkt-URL des Suchdiensts.

indexName
path True

string

Der Name des Index.

api-version
query True

string

minLength: 1

Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name Erforderlich Typ Beschreibung
x-ms-client-request-id

string (uuid)

Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

Accept

Accept

Der Accept-Header.

Antworten

Name Typ Beschreibung
200 OK

integer

Die Anforderung ist erfolgreich.

Media Types: "text/plain; charset=utf-8", "application/json"

Other Status Codes

ErrorResponse

Unerwartete Fehlerantwort.

Media Types: "text/plain; charset=utf-8", "application/json"

Sicherheit

api-key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiche

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

Beispiele

SearchIndexCountDocuments

Beispielanforderung

GET https://typespecpreviewexampleservice.search.windows.net/indexes('preview-test')/docs/$count?api-version=2026-11-01-preview


Beispiel für eine Antwort

50

Definitionen

Name Beschreibung
Accept

Der Accept-Header.

ErrorAdditionalInfo

Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung.

ErrorDetail

Die Fehlerdetails.

ErrorResponse

Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

Accept

Der Accept-Header.

Wert Beschreibung
application/json;odata.metadata=none

ErrorAdditionalInfo

Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung.

Name Typ Beschreibung
info

Zusätzliche Informationen.

type

string

Typ der Zusatzinformationen.

ErrorDetail

Die Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die Zusatzinformationen zum Fehler.

code

string

Der Fehlercode.

details

ErrorDetail[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Der Fehlerzielwert.

ErrorResponse

Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.