Dienststatistiken abrufen (Vorschau-REST-API)
gilt für: 2023-07-01-Preview. Diese Version wird nicht mehr unterstützt. Upgrade sofort auf eine neuere Version.
Wichtig
2023-07-01-Preview fügt vectorIndexSize bereichsbezogenen Suchdienst hinzu.
2021-04-30-Preview fügt aliasesCounthinzu.
Der Dienststatistik Vorgang gibt die Anzahl und den Typ von Objekten in Ihrem Dienst zurück, die maximal zulässige Anzahl für jeden Objekttyp, der die Dienstebene, den tatsächlichen und maximalen Speicher und andere Grenzwerte aufweist, die je nach Ebene variieren. Diese Anforderung ruft Informationen vom Dienst ab, sodass Sie Dienstbeschränkungen nichtnachschlagen oder berechnen müssen.
Statistiken zur Dokumentanzahl und Speichergröße werden alle paar Minuten und nicht in Echtzeit erfasst. Daher spiegeln die von dieser API zurückgegebenen Statistiken möglicherweise keine Änderungen wider, die durch die letzten Indizierungsvorgänge verursacht wurden.
GET https://[service name].search.windows.net/servicestats?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
URI-Parameter
| Parameter | Beschreibung |
|---|---|
| Dienstname | Erforderlich. Legen Sie diesen Wert auf den eindeutigen, benutzerdefinierten Namen Ihres Suchdiensts fest. Der Anforderungs-URI gibt den Namen des Indexes an, für den Statistiken zurückgegeben werden sollen. |
| API-Version | Erforderlich. Weitere Versionen finden Sie unter API-Versionen. |
Anforderungsheader
In der folgenden Tabelle werden die erforderlichen und optionalen Anforderungsheader beschrieben.
| Felder | Beschreibung |
|---|---|
| Inhaltstyp | Erforderlich. Legen Sie diesen Wert auf application/json |
| API-Schlüssel | Optional, wenn Sie Azure-Rollen verwenden und ein Bearertoken für die Anforderung bereitgestellt wird, andernfalls ist ein Schlüssel erforderlich. Ein API-Schlüssel ist eine eindeutige vom System generierte Zeichenfolge, die die Anforderung an Ihren Suchdienst authentifiziert. Abrufen von Anforderungen für den Suchdienst muss einen api-key Header enthalten, der auf Ihren Administratorschlüssel festgelegt ist (im Gegensatz zu einem Abfrageschlüssel). Weitere Informationen finden Sie unter Herstellen einer Verbindung mit Azure AI Search mithilfe der Schlüsselauthentifizierung. |
Anforderungstext
Nichts.
Antwort
Statuscode: "200 OK" wird für eine erfolgreiche Antwort zurückgegeben. Der Antworttext weist das folgende Format auf:
{
"counters": {
"documentCount": {
"usage": number,
"quota": number | null (if the service has unlimited document counts, the quota will be null)
},
"indexesCount": {
"usage": number,
"quota": number
},
"indexersCount": {
"usage": number,
"quota": number
},
"dataSourcesCount": {
"usage": number,
"quota": number
},
"storageSize": {
"usage": number (bytes),
"quota": number (bytes)
},
"synonymMaps": {
"usage": number,
"quota": number
},
"aliasesCount": {
"usage": number,
"quota": number
},
"vectorIndexSize": {
"usage": number (bytes),
"quota": number (bytes)
}
},
"limits": {
"maxFieldsPerIndex": number,
"maxIndexerRunTime": string,
"maxFileExtractionSize": number,
"maxFileContentCharactersToExtract": number,
"maxFieldNestingDepthPerIndex": number,
"maxComplexCollectionFieldsPerIndex": number,
"maxComplexObjectsInCollectionsPerDocument": number
}
}
| Statistik | Art | Beschreibung |
|---|---|---|
| documentCount | Zählen | Eine Aggregation aller Dokumente aus allen Indizes. In früheren Versionen von Azure AI Search wurden Grenzwerte für die Dokumentanzahl erzwungen, dieser Grenzwert ist jedoch nicht mehr vorhanden. Das Kontingent ist immer NULL, der angibt, dass der Dienst unbegrenzte Dokumentanzahlen aufweisen kann. |
| indexesCount | Zählen | Die Anzahl der Indizes für den Suchdienst. Maximale Indizes variieren je nach Ebene, wie vom Kontingent angegeben. |
| indexersCount | Zählen | Die Anzahl der Indexer für den Suchdienst. Die maximalen Indexer variieren je nach Ebene, wie vom Kontingent angegeben. |
| dataSourcesCount | Zählen | Die Anzahl der Datenquellen im Suchdienst. Die maximale Anzahl von Datenquellen variiert je nach Ebene, wie vom Kontingent gemeldet. Maximale Datenquellen sind die gleiche Zahl wie maximale Indexer. |
| aliasesCount | Zählen | Die Anzahl der Indexalias für den Suchdienst. Der Höchstwert variiert je nach Ebene, wie vom Kontingent angegeben. |
| synonymMaps | Zählen | Die Anzahl der Synonymzuordnungen für den Suchdienst. Der Höchstwert variiert je nach Ebene, wie vom Kontingent angegeben. |
| storageSize | Bytes | Die Verwendung ist der Speicherplatz, der von allen Objekten des Diensts verwendet wird. Das Kontingent ist der maximal verfügbare Speicher basierend auf der Größe und Anzahl der Partitionen, die für Ihren Dienst konfiguriert sind. Das Kontingent erhöht und verringert sich als Reaktion auf die Anzahl der partitionen, die im Suchdienst bereitgestellt wurden. Die Partitionsgröße variiert je nach Ebene. |
| vectorIndexSize | Bytes | Ein Vektorindex ist eine interne Struktur, ein Vektorindex pro Vektorfeld, wie in einem Suchindex definiert. Die Gesamtnutzung wird im gesamten Dienst gemeldet, sodass Sie den Vektorraumverbrauch relativ zum Vektorindexgrenzwert Ihres Suchdiensts überwachen können. Das Kontingent variiert je nach Alter des Suchdiensts, Der Anzahl der Partitionen und der Größe von Partitionen, die durch die Ebene bestimmt werden. |
Weitere Informationen zu allen Grenzwerten finden Sie unter Dienstbeschränkungen .
Beispiele
Diese API ist datenebene. Weitere Informationen zu einem Dienst, z. B. der Ebene oder dem Speicherort, finden Sie in der Verwaltungs-REST-API.
{
"@odata.context": "https://my-search-service.search.windows.net/$metadata#Microsoft.Azure.Search.V2019_05_06.ServiceStatistics",
"counters": {
"documentCount": {
"usage": 5072,
"quota": null
},
"indexesCount": {
"usage": 10,
"quota": 15
},
"indexersCount": {
"usage": 8,
"quota": 15
},
"dataSourcesCount": {
"usage": 9,
"quota": 15
},
"storageSize": {
"usage": 22265221,
"quota": 2147483648
},
"synonymMaps": {
"usage": 0,
"quota": 3
},
"aliasesCount": {
"usage": 7,
"quota": 30
},
"vectorIndexSize": {
"usage": 1342476,
"quota": 1073741824
},
"limits": {
"maxFieldsPerIndex": 1000,
"maxIndexerRunTime": "P1D",
"maxFileExtractionSize": 16777216,
"maxFileContentCharactersToExtract": 65536,
"maxFieldNestingDepthPerIndex": 10,
"maxComplexCollectionFieldsPerIndex": 40,
"maxComplexObjectsInCollectionsPerDocument": 3000
}
}