Uzyskiwanie statystyk usługi (interfejs API REST w wersji zapoznawczej)
Dotyczy: 2023-07-01-Preview, 2021-04-30-Preview
Ważne
2023-07-01-Preview dodaje właściwość vectorIndexSize o zakresie do usługi wyszukiwania.
2021-04-30-Preview dodaje aliasesCount.
Operacja Statystyka usługi zwraca liczbę i typ obiektów w usłudze, maksymalną dozwoloną dla każdego typu obiektu, biorąc pod uwagę warstwę usługi, rzeczywisty i maksymalny rozmiar magazynu oraz inne limity, które różnią się w zależności od warstwy. To żądanie pobiera informacje z usługi, aby nie trzeba było szukać ani obliczać limitów usług.
Statystyki dotyczące liczby dokumentów i rozmiaru magazynu są zbierane co kilka minut, a nie w czasie rzeczywistym. Dlatego statystyki zwrócone przez ten interfejs API mogą nie odzwierciedlać zmian spowodowanych ostatnimi operacjami indeksowania.
GET https://[service name].search.windows.net/servicestats?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Parametry identyfikatora URI
| Parametr | Opis |
|---|---|
| nazwa usługi | Wymagane. Ustaw tę wartość na unikatową, zdefiniowaną przez użytkownika nazwę usługi wyszukiwania. Identyfikator URI żądania określa nazwę indeksu, dla którego powinny zostać zwrócone statystyki. |
| api-version | Wymagane. Bieżąca wersja zapoznawcza to 2023-07-01-Preview. Zobacz Wersje interfejsu API , aby uzyskać więcej wersji. |
Nagłówki żądań
W poniższej tabeli opisano wymagane i opcjonalne nagłówki żądań.
| Pola | Opis |
|---|---|
| Content-Type | Wymagane. Ustaw tę wartość na application/json |
| api-key | Opcjonalnie, jeśli używasz ról platformy Azure , a token elementu nośnego jest dostarczany w żądaniu, w przeciwnym razie wymagany jest klucz. Api-key to unikatowy ciąg generowany przez system, który uwierzytelnia żądanie w usłudze wyszukiwania. Żądania dotyczące usługi wyszukiwania muszą zawierać api-key nagłówek ustawiony na klucz administratora (w przeciwieństwie do klucza zapytania). Aby uzyskać szczegółowe informacje, zobacz Nawiązywanie połączenia z usługą Azure AI Search przy użyciu uwierzytelniania klucza . |
Treść żądania
Brak.
Reakcja
Kod stanu: "200 OK" jest zwracany dla pomyślnej odpowiedzi. Treść odpowiedzi ma następujący 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
}
}
| Statystyka | Typ | Opis |
|---|---|---|
| documentCount | Liczba | Agregacja wszystkich dokumentów ze wszystkich indeksów. Wczesne wersje usługi Azure AI Search wymuszały limity liczby dokumentów, ale ten limit już nie istnieje. Limit przydziału jest zawsze zerowy wskazujący, że usługa może mieć nieograniczoną liczbę dokumentów. |
| indexesCount | Liczba | Liczba indeksów w usłudze wyszukiwania. Maksymalne indeksy różnią się w zależności od warstwy, co jest zgłaszane przez limit przydziału. |
| indexersCount | Liczba | Liczba indeksatorów w usłudze wyszukiwania. Maksymalne indeksatory różnią się w zależności od warstwy, co jest zgłaszane przez limit przydziału. |
| dataSourcesCount | Liczba | Liczba źródeł danych w usłudze wyszukiwania. Maksymalne źródła danych różnią się w zależności od warstwy, jak wynika z limitu przydziału. Maksymalna liczba źródeł danych jest taka sama jak maksymalna liczba indeksatorów. |
| aliasesCount | Liczba | Liczba aliasów indeksu w usłudze wyszukiwania. Maksymalna wartość zależy od warstwy, zgodnie z raportem limitu przydziału. |
| synonimyMapy | Liczba | Liczba map synonimów w usłudze wyszukiwania. Maksymalna wartość zależy od warstwy, zgodnie z raportem limitu przydziału. |
| rozmiar magazynu | Bajty | Użycie to ilość miejsca do magazynowania używanego przez wszystkie obiekty w usłudze. Limit przydziału to maksymalny dostępny magazyn na podstawie rozmiaru i liczby partycji skonfigurowanych dla usługi. Limit przydziału zwiększa się i zmniejsza w odpowiedzi na liczbę partycji aprowizowania w usłudze wyszukiwania. Rozmiar partycji różni się w zależności od warstwy. |
| vectorIndexSize | Bajty | Indeks wektorowy jest strukturą wewnętrzną, jedną indeksem wektorowym na pole wektorowe zdefiniowane w indeksie wyszukiwania. Łączne użycie jest raportowane w usłudze, aby można było monitorować zużycie przestrzeni wektorowej względem limitu indeksu wektorowego usługi wyszukiwania. Limit przydziału zależy od wieku usługi wyszukiwania, liczby partycji i rozmiaru partycji określonych według warstwy. |
Aby uzyskać więcej informacji na temat wszystkich limitów, zobacz Service limits (Limity usługi ).
Przykłady
Ten interfejs API jest płaszczyzną danych. Aby uzyskać więcej informacji na temat usługi, takiej jak warstwa lub lokalizacja, zobacz Interfejs API REST zarządzania.
{
"@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
}
}