Servicestatistieken ophalen (preview-REST API)
is van toepassing op: 2023-07-01-Preview. Deze versie wordt niet meer ondersteund. upgrade onmiddellijk naar een nieuwere versie.
Belangrijk
2023-07-01-Preview voegt vectorIndexSize toe beperkt tot een zoekservice.
2021-04-30-Preview voegt aliasesCounttoe.
De servicestatistieken bewerking retourneert het aantal en het type objecten in uw service, het maximum dat is toegestaan voor elk objecttype op basis van de servicelaag, werkelijke en maximale opslag en andere limieten die per laag variëren. Met deze aanvraag worden gegevens opgehaald uit de service, zodat u servicelimieten niet hoeft op te zoeken of te berekenen.
Statistieken over het aantal documenten en de opslaggrootte worden om de paar minuten verzameld, niet in realtime. De statistieken die door deze API worden geretourneerd, geven daarom mogelijk geen wijzigingen weer die worden veroorzaakt door recente indexeringsbewerkingen.
GET https://[service name].search.windows.net/servicestats?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
URI-parameters
| Parameter | Beschrijving |
|---|---|
| servicenaam | Vereist. Stel deze waarde in op de unieke, door de gebruiker gedefinieerde naam van uw zoekservice. De aanvraag-URI geeft de naam op van de index waarvoor statistieken moeten worden geretourneerd. |
| api-version | Vereist. Zie API-versies voor meer versies. |
Aanvraagheaders
In de volgende tabel worden de vereiste en optionele aanvraagheaders beschreven.
| Velden | Beschrijving |
|---|---|
| Inhoudstype | Vereist. Stel deze waarde in op application/json |
| api-key | Optioneel als u Azure-rollen gebruikt en er een bearer-token wordt opgegeven in de aanvraag, anders is een sleutel vereist. Een API-sleutel is een unieke, door het systeem gegenereerde tekenreeks waarmee de aanvraag wordt geverifieerd bij uw zoekservice. Aanvragen ophalen voor de zoekservice moet een api-key header bevatten die is ingesteld op uw beheersleutel (in plaats van een querysleutel). Zie Verbinding maken met Azure AI Search met behulp van sleutelverificatie voor meer informatie. |
Hoofdtekst van aanvraag
Geen.
Antwoord
Statuscode: '200 OK' wordt geretourneerd voor een geslaagd antwoord. De hoofdtekst van het antwoord heeft de volgende indeling:
{
"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
}
}
| Statistiek | Type | Beschrijving |
|---|---|---|
| documentCount | Tellen | Een aggregatie van alle documenten uit alle indexen. In eerdere versies van Azure AI Search zijn limieten voor het aantal documenten afgedwongen, maar deze limiet bestaat niet meer. Het quotum is altijd null om aan te geven dat de service onbeperkt aantal documenten kan hebben. |
| indexesCount | Tellen | Het aantal indexen in de zoekservice. De maximumindexen variëren per laag, zoals gerapporteerd door het quotum. |
| indexersCount | Tellen | Het aantal indexeerfuncties in de zoekservice. Maximumindexeerfuncties variëren per laag, zoals gerapporteerd door het quotum. |
| dataSourcesCount | Tellen | Het aantal gegevensbronnen in de zoekservice. De maximale gegevensbronnen variëren per laag, zoals gerapporteerd door het quotum. Maximale gegevensbronnen zijn hetzelfde aantal als de maximumindexeerfuncties. |
| aliasesCount | Tellen | Het aantal indexaliassen in de zoekservice. Maximum varieert per laag, zoals gerapporteerd door het quotum. |
| synoniemmaps | Tellen | Het aantal synoniementoewijzingen in de zoekservice. Maximum varieert per laag, zoals gerapporteerd door het quotum. |
| storageSize | Bytes | Gebruik is de hoeveelheid opslagruimte die door alle objecten in de service wordt gebruikt. Quotum is de maximale opslagruimte die beschikbaar is op basis van de grootte en het aantal partities dat is geconfigureerd voor uw service. Quotumverhogingen en afnames in reactie op het aantal partities dat is ingericht in de zoekservice. De partitiegrootte varieert per laag. |
| vectorIndexSize | Bytes | Een vectorindex is een interne structuur, één vectorindex per vectorveld zoals gedefinieerd in een zoekindex. Het totale gebruik wordt gerapporteerd in de service, zodat u het verbruik van vectorruimte kunt bewaken ten opzichte van de indexlimiet van de vector van uw zoekservice. Het quotum varieert per leeftijd van de zoekservice, het aantal partities en de grootte van partities, zoals wordt bepaald door de laag. |
Zie Servicelimieten voor meer informatie over alle limieten.
Voorbeelden
Deze API is een gegevensvlak. Zie de Management REST API-voor meer informatie over een service, zoals de laag of locatie.
{
"@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
}
}