Hämta tjänststatistik (förhandsversion av REST API)
gäller för: 2023-07-01-Preview. Den här versionen stöds inte längre. Uppgradera omedelbart till en nyare version.
Viktig
2023-07-01-Preview lägger till vectorIndexSize begränsad till en söktjänst.
2021-04-30-Preview lägger till aliasCount.
Åtgärden Service Statistics returnerar antalet och typen av objekt i tjänsten, det högsta tillåtna värdet för varje objekttyp med tanke på tjänstnivån, 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änstbegränsningar.
Statistik över antal dokument och lagringsstorlek samlas in med några minuters mellanrum, inte i realtid. Därför kanske den statistik 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. Se API-versioner för fler versioner. |
Begärandehuvuden
I följande tabell beskrivs de obligatoriska och valfria begäranderubrikerna.
| Fält | Beskrivning |
|---|---|
| Innehållstyp | Krävs. Ange det här värdet till application/json |
| api-key | Valfritt om du använder Azure-roller och en ägartoken anges i begäran, annars krävs en nyckel. En API-nyckel är en unik, systemgenererad sträng som autentiserar begäran till din söktjänst. Hämta begäranden mot söktjänsten måste innehålla ett api-key huvud inställt på administratörsnyckeln (i stället för en frågenyckel). Mer information finns i Anslut till Azure AI Search med hjälp av nyckelautentisering. |
Begärandetext
Ingen.
Svar
Statuskod: "200 OK" returneras för ett lyckat svar. Svarstexten är i 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 | Beskrivning |
|---|---|---|
| documentCount | Räkna | 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 | Räkna | Antalet index i söktjänsten. Maximala index varierar beroende på nivå, enligt kvoten. |
| indexersCount | Räkna | Antalet indexerare i söktjänsten. Maximalt antal indexerare varierar beroende på nivå, vilket rapporteras av kvoten. |
| dataSourcesCount | Räkna | Antalet datakällor i söktjänsten. Maximala datakällor varierar beroende på nivå, vilket rapporteras av kvoten. Maximala datakällor är samma antal som maximala indexerare. |
| aliasesCount | Räkna | Antalet indexalias i söktjänsten. Maximalt antal varierar beroende på nivå, enligt kvoten. |
| synonymMaps | Räkna | Antalet synonymkartor i söktjänsten. Maximalt antal varierar beroende på nivå, enligt kvoten. |
| storageSize | Byte | Användning är mängden lagringsutrymme som används av alla objekt i tjänsten. Kvoten är den maximala tillgängliga lagringen 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 hela tjänsten så att du kan övervaka vektorutrymmesförbrukning i förhållande till vektorindexgränsen för din söktjänst. Kvoten varierar beroende på söktjänstens ålder, antalet partitioner och storleken på partitionerna enligt 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, t.ex. nivån eller platsen, finns i rest-API:et för Management.
{
"@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
}
}