Servicestatistieken ophalen (preview-REST API)
Van toepassing op: 2023-07-01-Preview, 2021-04-30-Preview
Belangrijk
2023-07-01-Preview voegt vectorIndexSize scoped toe aan een zoekservice.
2021-04-30-Preview voegt aliassenCount toe.
De bewerking Servicestatistieken retourneert het aantal en het type objecten in uw service, het maximum dat is toegestaan voor elk objecttype op basis van de servicelaag, de werkelijke en maximale opslag en andere limieten die per laag verschillen. Met deze aanvraag wordt informatie opgehaald uit de service, zodat u geen servicelimieten hoeft op te zoeken of te berekenen.
Statistieken over het aantal documenten en de opslaggrootte worden om de paar minuten verzameld, niet in realtime. Daarom geven de statistieken die door deze API worden geretourneerd, 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-versie | Vereist. De huidige preview-versie is 2023-07-01-Preview. Zie API-versies voor meer versies. |
Aanvraagheaders
In de volgende tabel worden de vereiste en optionele aanvraagheaders beschreven.
| Velden | Description |
|---|---|
| Content-Type | Vereist. Stel deze waarde in op application/json |
| api-key | Optioneel als u Azure-rollen gebruikt en er een Bearer-token is opgegeven voor de aanvraag, anders is een sleutel vereist. Een API-sleutel is een unieke, door het systeem gegenereerde tekenreeks die de aanvraag verifieert bij uw zoekservice. Aanvragen voor de zoekservice moeten een api-key header bevatten die is ingesteld op uw beheerderssleutel (in plaats van een querysleutel). Zie Verbinding maken met Azure AI Search met behulp van sleutelverificatie voor meer informatie. |
Aanvraagbody
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
}
}
| Statistic | Type | Description |
|---|---|---|
| documentCount | Count | Een aggregatie van alle documenten uit alle indexen. In eerdere versies van Azure AI Search zijn limieten voor het aantal documenten afgedwongen, maar die limiet bestaat niet meer. Het quotum is altijd null, wat aangeeft dat de service een onbeperkt aantal documenten kan hebben. |
| indexesCount | Count | Het aantal indexen in de zoekservice. Het maximum aantal indexen verschilt per laag, zoals gerapporteerd door het quotum. |
| indexersCount | Count | Het aantal indexeerfuncties in de zoekservice. Het maximum aantal indexeerfuncties verschilt per laag, zoals gerapporteerd door het quotum. |
| dataSourcesCount | Count | Het aantal gegevensbronnen in de zoekservice. Het maximum aantal gegevensbronnen verschilt per laag, zoals gerapporteerd door het quotum. Het maximum aantal gegevensbronnen is hetzelfde als het maximum aantal indexeerfuncties. |
| aliassenCount | Count | Het aantal indexaliassen in de zoekservice. Maximum varieert per laag, zoals gerapporteerd door het quotum. |
| synonymMaps | Count | 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 voor uw service is geconfigureerd. Quotumverhogingen en -afnames als reactie op het aantal partities dat is ingericht in de zoekservice. De partitiegrootte verschilt 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 hele service, zodat u het verbruik van vectorruimte ten opzichte van de vectorindexlimiet van uw zoekservice kunt controleren. Het quotum is afhankelijk van de leeftijd van de zoekservice, het aantal partities en de grootte van partities, afhankelijk van 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
}
}