Szolgáltatásstatisztikák lekérése (ELŐZETES REST API)
A következőre vonatkozik: 2023-07-01-Preview, 2021-04-30-Preview
Fontos
2023-07-01-Preview hozzáadja a vectorIndexSize hatókört egy keresési szolgáltatáshoz.
2021-04-30-Preview hozzáadja az aliasokatCount.
A Szolgáltatásstatisztika művelet visszaadja a szolgáltatásban lévő objektumok számát és típusát, a szolgáltatási szintnek, a tényleges és maximális tárterületnek, valamint az egyes objektumtípusokhoz megengedett maximális értéket, valamint a szinttől függően eltérő egyéb korlátokat. Ez a kérés adatokat kér le a szolgáltatásból, hogy ne kelljen szolgáltatási korlátokat keresnie vagy kiszámítania.
A dokumentumszámra és a tárterület méretére vonatkozó statisztikák gyűjtése néhány percenként történik, nem valós időben. Ezért előfordulhat, hogy az API által visszaadott statisztikák nem tükrözik a legutóbbi indexelési műveletek által okozott változásokat.
GET https://[service name].search.windows.net/servicestats?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
URI-paraméterek
| Paraméter | Leírás |
|---|---|
| szolgáltatásnév | Kötelező. Állítsa ezt az értéket a keresési szolgáltatás egyedi, felhasználó által definiált nevére. A kérelem URI-ja határozza meg annak az indexnek a nevét, amelyhez a statisztikákat vissza kell adni. |
| api-verzió | Kötelező. Az aktuális előzetes verzió: 2023-07-01-Preview. További verziókért lásd: API-verziók . |
Kérelemfejlécek
Az alábbi táblázat a szükséges és nem kötelező kérésfejléceket ismerteti.
| Mezők | Description |
|---|---|
| Content-Type | Kötelező. Állítsa ezt az értéket a következő értékre: application/json |
| api-key | Nem kötelező , ha Azure-szerepköröket használ, és egy tulajdonosi jogkivonatot ad meg a kéréshez, ellenkező esetben kulcsra van szükség. Az API-kulcs egy egyedi, rendszer által generált sztring, amely hitelesíti a kérést a keresési szolgáltatásnak. A keresési szolgáltatással kapcsolatos kérelmeknek tartalmazniuk kell egy api-key , a rendszergazdai kulcsra beállított fejlécet (a lekérdezési kulcs helyett). A részletekért lásd: Csatlakozás az Azure AI Search szolgáltatáshoz kulcshitelesítés használatával . |
Kérelem törzse
Nincsenek.
Reagálás
Állapotkód: A rendszer az "200 OK" értéket adja vissza a sikeres válaszhoz. A válasz törzse a következő formátumban van:
{
"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
}
}
| Statisztikai adatok | Típus | Description |
|---|---|---|
| documentCount | Darabszám | Az összes dokumentum összesítése az összes indexből. Az Azure AI Search kényszerített dokumentumszámkorlátainak korai verziói, de ez a korlát már nem létezik. A kvóta mindig null értékű, ami azt jelzi, hogy a szolgáltatás korlátlan számú dokumentumot tartalmazhat. |
| indexesCount | Darabszám | A keresési szolgáltatás indexeinek száma. A maximális indexek szintjenként változnak a kvóta által jelentett módon. |
| indexelőkCount | Darabszám | A keresési szolgáltatás indexelőinek száma. A maximális indexelők szintjenként változnak a kvóta által jelentett módon. |
| dataSourcesCount | Darabszám | A keresési szolgáltatás adatforrásainak száma. A maximális adatforrások szintjenként változik a kvóta által jelentett módon. A maximális adatforrások száma megegyezik a maximális indexelők számával. |
| aliasesCount | Darabszám | A keresési szolgáltatás indexaliasainak száma. A maximális érték szint szerint változik a kvóta által jelentett módon. |
| szinonimatérképek | Darabszám | Szinonimatérképek száma a keresési szolgáltatásban. A maximális érték szint szerint változik a kvóta által jelentett módon. |
| storageSize | Bájt | A használat a szolgáltatás összes objektuma által használt tárterület. A kvóta a szolgáltatáshoz konfigurált partíciók méretétől és számától függően elérhető maximális tárterület. A kvóta növekszik és csökken a keresési szolgáltatásban kiépített partíciók számának hatására. A partíció mérete szint szerint változik. |
| vectorIndexSize | Bájt | A vektorindex egy belső struktúra, egy vektorindex vektormezőnként, a keresési indexben meghatározott módon. A szolgáltatás teljes kihasználtságát a rendszer jelenti, így a keresési szolgáltatás vektorindex-korlátjához képest figyelheti a vektortérhasználatot. A kvóta a keresési szolgáltatás életkorától, a partíciók számától és a partíciók szint által meghatározott méretétől függően változik. |
További információ az összes korlátról: Szolgáltatáskorlátok .
Példák
Ez az API adatsík. Ha további információt szeretne kapni egy szolgáltatásról, például a szintről vagy a helyről, tekintse meg a Felügyeleti REST API-t.
{
"@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
}
}