Documents - Count

Dienst:: Search Service

API-Version:: 2025-11-01-preview

Fragt die Anzahl der Dokumente im Index ab.

GET {endpoint}/indexes('{indexName}')/docs/$count?api-version=2025-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	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Accept		Accept	Die Überschrift "Annehmen".
x-ms-client-request-id		string (uuid)	Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

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"

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

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

Definitionen

Name	Beschreibung
Accept	Die Überschrift "Annehmen".
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das 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

Enumeration

Die Überschrift "Annehmen".

Wert	Beschreibung
application/json;odata.metadata=none

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info		Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

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.