Get Service Statistics - Get Service Statistics

Usługa:

Search Service

Wersja interfejsu API:

2026-05-01-preview

Pobiera statystyki poziomu usługi dla usługi wyszukiwania.

GET {endpoint}/servicestats?api-version=2026-05-01-preview

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string (uri)	Adres URL punktu końcowego usługi wyszukiwania.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Accept		Accept	Nagłówek Accept.
x-ms-client-request-id		string (uuid)	Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SearchServiceStatistics	Żądanie zakończyło się pomyślnie.
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

api-key

Typ: apiKey
W: header

OAuth2Auth

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Zakresy

Nazwa	Opis
https://search.azure.com/.default

Przykłady

SearchServiceGetS3HDUnlimitedServiceStatistics

SearchServiceGetServiceStatistics

SearchServiceGetS3HDUnlimitedServiceStatistics

Przykładowe żądanie

HTTP

GET https://previewexampleservice.search.windows.net/servicestats?api-version=2026-05-01-preview

Przykładowa odpowiedź

Kod stanu:

200

{
  "counters": {
    "documentCount": {
      "usage": 12
    },
    "indexesCount": {
      "usage": 2,
      "quota": 2
    },
    "indexersCount": {
      "usage": 2,
      "quota": 2
    },
    "dataSourcesCount": {
      "usage": 2,
      "quota": 2
    },
    "storageSize": {
      "usage": 123456,
      "quota": 10485760
    },
    "synonymMaps": {
      "usage": 3,
      "quota": 3
    },
    "skillsetCount": {
      "usage": 2,
      "quota": 2
    },
    "aliasesCount": {
      "usage": 4,
      "quota": 4
    },
    "vectorIndexSize": {
      "usage": 123456
    },
    "knowledgeBasesCount": {
      "usage": 0,
      "quota": 2
    },
    "knowledgeSourcesCount": {
      "usage": 0,
      "quota": 2
    }
  },
  "indexersRuntime": {
    "usedSeconds": 0,
    "remainingSeconds": 86400,
    "beginningTime": "2024-06-06T00:00:00.000Z",
    "endingTime": "2024-06-07T00:00:00.000Z"
  },
  "limits": {
    "maxStoragePerIndex": 10485760,
    "maxFieldsPerIndex": 1000,
    "maxFieldNestingDepthPerIndex": 10,
    "maxComplexCollectionFieldsPerIndex": 40,
    "maxComplexObjectsInCollectionsPerDocument": 3000,
    "maxCumulativeIndexerRuntimeSeconds": 86400
  }
}

SearchServiceGetServiceStatistics

Przykładowe żądanie

HTTP

GET https://previewexampleservice.search.windows.net/servicestats?api-version=2026-05-01-preview

Przykładowa odpowiedź

Kod stanu:

200

{
  "counters": {
    "documentCount": {
      "usage": 12
    },
    "indexesCount": {
      "usage": 2,
      "quota": 2
    },
    "indexersCount": {
      "usage": 2,
      "quota": 2
    },
    "dataSourcesCount": {
      "usage": 2,
      "quota": 2
    },
    "storageSize": {
      "usage": 123456,
      "quota": 10485760
    },
    "synonymMaps": {
      "usage": 3,
      "quota": 3
    },
    "skillsetCount": {
      "usage": 2,
      "quota": 2
    },
    "aliasesCount": {
      "usage": 4,
      "quota": 4
    },
    "vectorIndexSize": {
      "usage": 123456
    },
    "knowledgeBasesCount": {
      "usage": 0,
      "quota": 2
    },
    "knowledgeSourcesCount": {
      "usage": 0,
      "quota": 2
    }
  },
  "indexersRuntime": {
    "usedSeconds": 0,
    "beginningTime": "2024-06-06T00:00:00.000Z",
    "endingTime": "2024-06-07T00:00:00.000Z"
  },
  "limits": {
    "maxStoragePerIndex": 10485760,
    "maxFieldsPerIndex": 1000,
    "maxFieldNestingDepthPerIndex": 10,
    "maxComplexCollectionFieldsPerIndex": 40,
    "maxComplexObjectsInCollectionsPerDocument": 3000
  }
}

Definicje

Nazwa	Opis
Accept	Nagłówek Accept.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).
ResourceCounter	Reprezentuje użycie i limit przydziału zasobu.
SearchServiceCounters	Reprezentuje liczniki zasobów na poziomie usługi i limity przydziału.
SearchServiceLimits	Reprezentuje różne limity poziomu usług.
SearchServiceStatistics	Odpowiedź z żądania pobierania statystyk usługi. Jeśli to się powiedzie, obejmuje liczniki i limity poziomu usług.
ServiceIndexersRuntime	Reprezentuje liczniki uruchomienia indeksera na poziomie usług.

Accept

Wyliczenie

Nagłówek Accept.

Wartość	Opis
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info		Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Cel błędu.

ErrorResponse

Objekt

Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

ResourceCounter

Objekt

Reprezentuje użycie i limit przydziału zasobu.

Nazwa	Typ	Opis
quota	integer (int64)	Limit przydziału ilości zasobu.
usage	integer (int64)	Ilość użycia zasobu.

SearchServiceCounters

Objekt

Reprezentuje liczniki zasobów na poziomie usługi i limity przydziału.

Nazwa	Typ	Opis
aliasesCount	ResourceCounter	Łączna liczba aliasów.
dataSourcesCount	ResourceCounter	Całkowita liczba źródeł danych.
documentCount	ResourceCounter	Łączna liczba dokumentów we wszystkich indeksach w usłudze.
indexersCount	ResourceCounter	Łączna liczba indeksatorów.
indexesCount	ResourceCounter	Łączna liczba indeksów.
knowledgeBasesCount	ResourceCounter	Łączna liczba baz wiedzy.
knowledgeSourcesCount	ResourceCounter	Łączna liczba źródeł wiedzy.
skillsetCount	ResourceCounter	Łączna liczba zestawów umiejętności.
storageSize	ResourceCounter	Całkowity rozmiar używanego magazynu w bajtach.
synonymMaps	ResourceCounter	Łączna liczba map synonimów.
vectorIndexSize	ResourceCounter	Całkowite użycie pamięci wszystkich indeksów wektorów w usłudze w bajtach.

SearchServiceLimits

Objekt

Reprezentuje różne limity poziomu usług.

Nazwa	Typ	Opis
maxComplexCollectionFieldsPerIndex	integer (int32)	Maksymalna liczba pól typu Collection(Edm.ComplexType) dozwolona w indeksie.
maxComplexObjectsInCollectionsPerDocument	integer (int32)	Maksymalna liczba obiektów w złożonych kolekcjach dozwolonych dla dokumentu.
maxCumulativeIndexerRuntimeSeconds	integer (int64)	Maksymalny skumulowany czas działania indeksera w sekundach dozwolony dla usługi.
maxFieldNestingDepthPerIndex	integer (int32)	Maksymalna głębokość, którą można zagnieżdżać podpola w indeksie, w tym pole złożone najwyższego poziomu. Na przykład a/b/c ma głębokość zagnieżdżania 3.
maxFieldsPerIndex	integer (int32)	Maksymalna dozwolona liczba pól na indeks.
maxStoragePerIndex	integer (int64)	Maksymalna ilość miejsca do magazynowania w bajtach dozwolonych na indeks.

SearchServiceStatistics

Objekt

Odpowiedź z żądania pobierania statystyk usługi. Jeśli to się powiedzie, obejmuje liczniki i limity poziomu usług.

Nazwa	Typ	Opis
counters	SearchServiceCounters	Liczniki zasobów na poziomie usługi.
indexersRuntime	ServiceIndexersRuntime	Zużycie czasu uruchomienia indeksera na poziomie usług.
limits	SearchServiceLimits	Ogólne limity poziomu usługi.

ServiceIndexersRuntime

Objekt

Reprezentuje liczniki uruchomienia indeksera na poziomie usług.

Nazwa	Typ	Opis
beginningTime	string (date-time)	Początkowy czas UTC 24-godzinnego okresu branego pod uwagę użycie środowiska uruchomieniowego indeksatora (włącznie).
endingTime	string (date-time)	Godzina zakończenia UTC 24-godzinnego okresu branego pod uwagę użycie środowiska uruchomieniowego indeksatora (włącznie).
remainingSeconds	integer (int64)	Skumulowane środowisko uruchomieniowe pozostałe dla wszystkich indeksatorów w usłudze od beginningTime do endingTime w sekundach.
usedSeconds	integer (int64)	Skumulowane środowisko uruchomieniowe wszystkich indeksatorów w usłudze od beginningTime do endingTime w sekundach.