Tjänststatistik i Azure Cognitive Search (förhandsversion av REST API)

API-version: 2021-04-30-Preview

Viktigt

Den här förhandsversionen lägger till ett aliasCount i den befintliga tjänststatistiken.

Åtgärden Tjänststatistik returnerar antalet och typen av objekt i tjänsten, det högsta tillåtna värdet för varje objekttyp beroende på tjänstnivå, 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 leta upp eller beräkna tjänstbegränsningar.

Statistik för antal dokument och lagringsstorlek samlas in med några minuters mellanrum, inte i realtid. Därför kanske statistiken 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 unika, användardefinierade namnet på söktjänsten. Begärande-URI anger namnet på indexet som statistik ska returneras för.
api-version Krävs. Den aktuella stabila versionen är api-version=2020-06-30. Fler versioner finns i API-versioner .

Rubriker för begäran

I följande tabell beskrivs de obligatoriska och valfria begärandehuvudena.

Fält Beskrivning
Content-Type Krävs. Ange detta till application/json
api-key Krävs. API-nyckeln används för att autentisera begäran till din tjänsten Search. Det är ett strängvärde som är unikt för din tjänst. Hämta begäranden om systeminformation måste innehålla ett API-nyckelfält som är inställt på din administratörsnyckel (till skillnad från en frågenyckel). Du hittar API-nyckeln på instrumentpanelen för söktjänsten i Azure Portal.

Begärandetext

Inga.

Svarsåtgärder

Statuskod: "200 OK" returneras för ett lyckat svar. Svarstexten har följande 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
    }
}

Exempel

{
    "@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
    }
}

Se även