Get Service Statistics - Get Service Statistics

Dienst:

Search Service

API-Version:

2026-04-01

Ruft Statistiken zum Dienstlevel für einen Suchdienst ab.

GET {endpoint}/servicestats?api-version=2026-04-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Die Endpunkt-URL des Suchdiensts.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

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	SearchServiceStatistics	Die Anforderung ist erfolgreich.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

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

SearchServiceGetS3HDUnlimitedServiceStatistics

SearchServiceGetServiceStatistics

SearchServiceGetS3HDUnlimitedServiceStatistics

Beispielanforderung

HTTP

GET https://exampleservice.search.windows.net/servicestats?api-version=2026-04-01

Beispiel für eine Antwort

Statuscode:

200

{
  "counters": {
    "documentCount": {
      "usage": 12
    },
    "indexesCount": {
      "usage": 2,
      "quota": 2
    },
    "indexersCount": {
      "usage": 2,
      "quota": 2
    },
    "dataSourcesCount": {
      "usage": 2,
      "quota": 2
    },
    "storageSize": {
      "usage": 123456,
      "quota": 10485760
    },
    "synonymMaps": {
      "usage": 3,
      "quota": 3
    },
    "skillsetCount": {
      "usage": 2,
      "quota": 2
    },
    "aliasesCount": {
      "usage": 4,
      "quota": 4
    },
    "vectorIndexSize": {
      "usage": 123456
    }
  },
  "limits": {
    "maxStoragePerIndex": 10485760,
    "maxFieldsPerIndex": 1000,
    "maxFieldNestingDepthPerIndex": 10,
    "maxComplexCollectionFieldsPerIndex": 40,
    "maxComplexObjectsInCollectionsPerDocument": 3000,
    "maxCumulativeIndexerRuntimeSeconds": 86400
  }
}

SearchServiceGetServiceStatistics

Beispielanforderung

HTTP

GET https://exampleservice.search.windows.net/servicestats?api-version=2026-04-01

Beispiel für eine Antwort

Statuscode:

200

{
  "counters": {
    "documentCount": {
      "usage": 12
    },
    "indexesCount": {
      "usage": 2,
      "quota": 2
    },
    "indexersCount": {
      "usage": 2,
      "quota": 2
    },
    "dataSourcesCount": {
      "usage": 2,
      "quota": 2
    },
    "storageSize": {
      "usage": 123456,
      "quota": 10485760
    },
    "synonymMaps": {
      "usage": 3,
      "quota": 3
    },
    "skillsetCount": {
      "usage": 2,
      "quota": 2
    },
    "aliasesCount": {
      "usage": 4,
      "quota": 4
    },
    "vectorIndexSize": {
      "usage": 123456
    }
  },
  "limits": {
    "maxStoragePerIndex": 10485760,
    "maxFieldsPerIndex": 1000,
    "maxFieldNestingDepthPerIndex": 10,
    "maxComplexCollectionFieldsPerIndex": 40,
    "maxComplexObjectsInCollectionsPerDocument": 3000
  }
}

Definitionen

Name	Beschreibung
Accept	Die Überschrift "Annehmen".
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Übliche Fehlerantwort für alle Azure Resource Manager APIs, um Fehlerdetails bei fehlgeschlagenen Operationen zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)
ResourceCounter	Stellt die Verwendung und das Kontingent einer Ressource dar.
SearchServiceCounters	Stellt Ressourcenzähler und Kontingente auf Dienstebene dar.
SearchServiceLimits	Stellt verschiedene Grenzwerte für Dienstebene dar.
SearchServiceStatistics	Antwort von einer Anforderung zum Abrufen von Dienststatistiken. Wenn dies erfolgreich ist, enthält es Leistungsindikatoren und Grenzwerte auf Serviceebene.

Accept

Enumeration

Die Überschrift "Annehmen".

Wert	Beschreibung
application/json;odata.metadata=minimal

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

Übliche Fehlerantwort für alle Azure Resource Manager APIs, um Fehlerdetails bei fehlgeschlagenen Operationen zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

ResourceCounter

Objekt

Stellt die Verwendung und das Kontingent einer Ressource dar.

Name	Typ	Beschreibung
quota	integer (int64)	Das Kontingent für die Ressourcenmenge.
usage	integer (int64)	Die Menge der Ressourcennutzung.

SearchServiceCounters

Objekt

Stellt Ressourcenzähler und Kontingente auf Dienstebene dar.

Name	Typ	Beschreibung
aliasesCount	ResourceCounter	Gesamtzahl der Aliase.
dataSourcesCount	ResourceCounter	Gesamtzahl der Datenquellen.
documentCount	ResourceCounter	Die Gesamtzahl der Dokumente in allen Indizes des Diensts.
indexersCount	ResourceCounter	Gesamtanzahl der Indexer.
indexesCount	ResourceCounter	Gesamtanzahl der Indizes.
skillsetCount	ResourceCounter	Gesamtzahl der Fähigkeiten.
storageSize	ResourceCounter	Gesamtgröße des verwendeten Speichers in Bytes.
synonymMaps	ResourceCounter	Gesamtanzahl der Synonymzuordnungen.
vectorIndexSize	ResourceCounter	Gesamtspeicherverbrauch aller Vektorindizes innerhalb des Diensts in Byte.

SearchServiceLimits

Objekt

Stellt verschiedene Grenzwerte für Dienstebene dar.

Name	Typ	Beschreibung
maxComplexCollectionFieldsPerIndex	integer (int32)	Die maximale Anzahl von Feldern vom Typ Collection(Edm.ComplexType) in einem Index zulässig.
maxComplexObjectsInCollectionsPerDocument	integer (int32)	Die maximale Anzahl von Objekten in komplexen Auflistungen pro Dokument zulässig.
maxCumulativeIndexerRuntimeSeconds	integer (int64)	Die maximale kumulative Laufzeit des Indexiers in Sekunden war für den Dienst erlaubt.
maxFieldNestingDepthPerIndex	integer (int32)	Die maximale Tiefe, die Sie Unterfelder in einem Index schachteln können, einschließlich des komplexen Felds der obersten Ebene. Beispielsweise hat a/b/c eine Schachtelungstiefe von 3.
maxFieldsPerIndex	integer (int32)	Die maximal zulässigen Felder pro Index.
maxStoragePerIndex	integer (int64)	Die maximale Speichermenge in Bytes, die pro Index zulässig sind.

SearchServiceStatistics

Objekt

Antwort von einer Anforderung zum Abrufen von Dienststatistiken. Wenn dies erfolgreich ist, enthält es Leistungsindikatoren und Grenzwerte auf Serviceebene.

Name	Typ	Beschreibung
counters	SearchServiceCounters	Leistungsindikatoren für Servicelevel-Ressourcen.
limits	SearchServiceLimits	Allgemeine Grenzwerte für Servicelevel.