Hämta tjänststatistik (förhandsversion av REST API)
Gäller för: 2023-07-01-Preview, 2021-04-30-Preview
Viktigt
2023-07-01-Preview lägger till vectorIndexSize som är begränsad till en söktjänst.
2021-04-30-Preview lägger till aliasCount.
Åtgärden Tjänststatistik returnerar antalet och typen av objekt i tjänsten, det högsta tillåtna värdet för varje objekttyp beroende på tjänstnivå, faktisk och maximal lagring och andra gränser som varierar beroende på nivå. Den här begäran hämtar information från tjänsten så att du inte behöver söka efter eller beräkna tjänstgränser.
Statistik över antal dokument och lagringsstorlek samlas in med några minuters mellanrum, inte i realtid. Därför kanske statistiken som returneras av det här API:et inte återspeglar ändringar som orsakats av de senaste indexeringsåtgärderna.
GET https://[service name].search.windows.net/servicestats?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
URI-parametrar
| Parameter | Beskrivning |
|---|---|
| tjänstnamn | Krävs. Ange det här värdet till det unika, användardefinierade namnet på söktjänsten. Begärande-URI anger namnet på indexet för vilket statistik ska returneras. |
| api-version | Krävs. Den aktuella förhandsversionen är 2023-07-01-Preview. Se API-versioner för fler versioner. |
Rubriker för begäran
I följande tabell beskrivs nödvändiga och valfria begärandehuvuden.
| Fält | Description |
|---|---|
| Content-Type | Krävs. Ange det här värdet till application/json |
| api-key | Valfritt om du använder Azure-roller och en ägartoken anges på begäran, annars krävs en nyckel. En API-nyckel är en unik, systemgenererad sträng som autentiserar begäran till söktjänsten. Get requests against the search service must include an api-key header set to your admin key (i motsats till en frågenyckel). Mer information finns i Ansluta till Azure AI Search med nyckelautentisering . |
Begärandetext
Inga.
Svarsåtgärder
Statuskod: "200 OK" returneras för ett lyckat svar. Svarstexten har följande format:
{
"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 | Typ | Description |
|---|---|---|
| documentCount | Antal | En aggregering av alla dokument från alla index. Tidiga versioner av Azure AI Search framtvingade begränsningar för antal dokument, men den gränsen finns inte längre. Kvoten är alltid null som anger att tjänsten kan ha obegränsat antal dokument. |
| indexesCount | Antal | Antalet index i söktjänsten. Maximalt antal index varierar beroende på nivå, vilket rapporteras av kvoten. |
| indexersCount | Antal | Antalet indexerare i söktjänsten. Maximalt antal indexerare varierar beroende på nivå, vilket rapporteras av kvoten. |
| dataSourcesCount | Antal | Antalet datakällor i söktjänsten. Maximalt antal datakällor varierar beroende på nivå, vilket rapporteras av kvoten. Maximalt antal datakällor är samma antal som maximalt antal indexerare. |
| aliasesCount | Antal | Antalet indexalias i söktjänsten. Maximalt varierar beroende på nivå enligt kvoten. |
| synonymKartor | Antal | Antalet synonymkartor i söktjänsten. Maximalt varierar beroende på nivå enligt kvoten. |
| storageSize | Byte | Användning är mängden lagringsutrymme som används av alla objekt i tjänsten. Kvot är den maximala lagring som är tillgänglig baserat på storleken och antalet partitioner som konfigurerats för din tjänst. Kvoten ökar och minskar som svar på antalet partitioner som etablerats i söktjänsten. Partitionsstorleken varierar beroende på nivå. |
| vectorIndexSize | Byte | Ett vektorindex är en intern struktur, ett vektorindex per vektorfält enligt definitionen i ett sökindex. Total användning rapporteras i tjänsten så att du kan övervaka vektorutrymmesförbrukning i förhållande till vektorindexgränsen för söktjänsten. Kvoten varierar beroende på söktjänstens ålder, antalet partitioner och storleken på partitionerna beroende på nivå. |
Mer information om alla gränser finns i Tjänstbegränsningar .
Exempel
Det här API:et är ett dataplan. Mer information om en tjänst, till exempel dess nivå eller plats, finns i REST-API:et för hantering.
{
"@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
}
}