Statystyki usługi w Azure Cognitive Search (interfejs API REST w wersji zapoznawczej)

Wersja interfejsu API: 2021-04-30-Preview

Ważne

Ta wersja zapoznawcza dodaje aliasesCount do istniejących statystyk usługi.

Operacja Statystyki 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 stabilna wersja to api-version=2020-06-30. 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 Wymagane. Klucz api-key służy do uwierzytelniania żądania w usługa wyszukiwania. Jest to wartość ciągu, unikatowa dla twojej usługi. Żądania pobierania informacji o systemie muszą zawierać pole api-key ustawione na klucz administratora (w przeciwieństwie do klucza zapytania). Klucz interfejsu API można znaleźć na pulpicie nawigacyjnym usługi wyszukiwania w Azure Portal.

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 unlimitied 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
        }
    },
    "limits": {
        "maxFieldsPerIndex": number,
        "maxIndexerRunTime": string,
        "maxFileExtractionSize": number,
        "maxFileContentCharactersToExtract": number,
        "maxFieldNestingDepthPerIndex": number,
        "maxComplexCollectionFieldsPerIndex": number,
        "maxComplexObjectsInCollectionsPerDocument": number
    }
}

Przykłady

{
    "@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": 15
        }
    },
    "limits": {
        "maxFieldsPerIndex": 1000,
        "maxIndexerRunTime": "P1D",
        "maxFileExtractionSize": 16777216,
        "maxFileContentCharactersToExtract": 65536,
        "maxFieldNestingDepthPerIndex": 10,
        "maxComplexCollectionFieldsPerIndex": 40,
        "maxComplexObjectsInCollectionsPerDocument": 3000
    }
}

Zobacz też