Získání statistik služby (Preview REST API)
platí pro: 2023-07-01-Preview. Tato verze se už nepodporuje. okamžitě upgradovat na novější verzi.
Důležitý
2023-07-01-Preview přidává vectorIndexSize vymezený do vyhledávací služby.
2021-04-30-Preview přidává aliasesCount.
Operace Statistika služby vrátí počet a typ objektů ve vaší službě, maximální povolený pro každý typ objektu s ohledem na úroveň služby, skutečné a maximální úložiště a další limity, které se liší podle úrovně. Tato žádost o přijetí změn informací ze služby vyžaduje, abyste nemuseli vyhledávat ani počítat limity služby .
Statistiky o počtu dokumentů a velikosti úložiště se shromažďují každých několik minut, ne v reálném čase. Statistiky vrácené tímto rozhraním API proto nemusí odrážet změny způsobené nedávnými operacemi indexování.
GET https://[service name].search.windows.net/servicestats?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Parametry identifikátoru URI
| Parametr | Popis |
|---|---|
| název služby | Požadovaný. Nastavte tuto hodnotu na jedinečný uživatelsky definovaný název vyhledávací služby. Identifikátor URI požadavku určuje název indexu, pro který se mají vrátit statistiky. |
| api-version | Požadovaný. Další verze najdete v verzích rozhraní API. |
Hlavičky požadavku
Následující tabulka popisuje povinnou a volitelnou hlavičku požadavku.
| Pole | Popis |
|---|---|
| Typ obsahu | Požadovaný. Nastavte tuto hodnotu na application/json |
| api-key | Volitelné, pokud používáte role Azure a v požadavku je k dispozici nosný token, jinak se vyžaduje klíč. Api-key je jedinečný systémový vygenerovaný řetězec, který ověřuje požadavek ve vaší vyhledávací službě. Požadavky na vyhledávací službu musí obsahovat hlavičku api-key nastavenou na klíč správce (na rozdíl od klíče dotazu). Podrobnosti najdete v tématu Připojení k Azure AI Search pomocí ověřování klíčů. |
Text požadavku
Žádný.
Odpověď
Stavový kód: "200 OK" se vrátí pro úspěšnou odpověď. Text odpovědi je v následujícím formátu:
{
"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
}
}
| Statistický | Typ | Popis |
|---|---|---|
| documentCount | Počítat | Agregace všech dokumentů ze všech indexů. Dřívější verze služby Azure AI Search vynutily limity počtu dokumentů, ale tento limit už neexistuje. Kvóta je vždy null, což znamená, že služba může mít neomezený počet dokumentů. |
| indexesCount | Počítat | Počet indexů ve vyhledávací službě. Maximální indexy se liší podle úrovně, jak je hlášeno kvótou. |
| indexersCount | Počítat | Počet indexerů ve vyhledávací službě. Maximální indexery se liší podle úrovně, jak je hlášeno kvótou. |
| dataSourcesCount | Počítat | Počet zdrojů dat ve vyhledávací službě. Maximální počet zdrojů dat se liší podle úrovně, jak je hlášeno kvótou. Maximální počet zdrojů dat je stejný jako maximální indexery. |
| aliasesCount | Počítat | Počet aliasů indexu ve vyhledávací službě. Maximální počet se liší podle úrovně, jak je hlášeno kvótou. |
| synonymMaps | Počítat | Počet map synonym ve vyhledávací službě. Maximální počet se liší podle úrovně, jak je hlášeno kvótou. |
| storageSize | Byty | Využití je velikost úložiště používaná všemi objekty ve službě. Kvóta je maximální dostupné úložiště na základě velikosti a počtu oddílů nakonfigurovaných pro vaši službu. Kvóta se zvyšuje a snižuje v reakci na počet oddílů zřízených ve vyhledávací službě. Velikost oddílu se liší podle úrovně. |
| vectorIndexSize | Byty | Vektorový index je vnitřní struktura, jeden vektorový index na pole vektoru definovaný v indexu vyhledávání. Celkové využití se v celé službě hlásí, takže můžete monitorovat spotřebu vektorového prostoru vzhledem k limitu indexu vektoru vaší vyhledávací služby. Kvóta se liší podle věku vyhledávací služby, počtu oddílů a velikosti oddílů podle úrovně. |
Další informace o všech omezeních najdete v tématu Omezení služby .
Příklady
Toto rozhraní API je rovina dat. Další informace o službě, jako je její úroveň nebo umístění, najdete vrozhraní REST API služby
{
"@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
}
}