Azure Cognitive Search 서비스 통계(미리 보기 REST API)

API 버전: 2021-04-30-Preview

중요

이 미리 보기에서는 기존 서비스 통계에 aliasesCount 를 추가합니다.

서비스 통계 작업은 서비스의 개체 수와 형식, 서비스 계층, 실제 및 최대 스토리지 및 계층에 따라 달라지는 기타 제한을 감안할 때 각 개체 유형에 허용되는 최대값을 반환합니다. 이 요청은 서비스 제한을 조회하거나 계산할 필요가 없도록 서비스에서 정보를 가져옵니다.

문서 수와 스토리지 크기에 대한 통계는 실시간이 아니라 몇 분 간격으로 수집됩니다. 따라서 이 API에서 반환된 통계는 최근 인덱싱 작업으로 인해 발생한 변경 내용을 반영하지 않을 수 있습니다.

GET https://[service name].search.windows.net/servicestats?api-version=[api-version]
   Content-Type: application/json  
   api-key: [admin key]  

URI 매개 변수

매개 변수 Description
서비스 이름 필수 요소. 검색 서비스의 고유한 사용자 정의 이름으로 설정합니다. 요청 URI는 통계가 반환되어야 하는 인덱스의 이름을 지정합니다.
api-version 필수 요소. 현재 안정적인 버전은 .입니다 api-version=2020-06-30. 더 많은 버전은 API 버전을 참조하세요.

요청 헤더

다음 표에서는 필수 요청 헤더와 선택적 요청 헤더에 대해 설명합니다.

필드 Description
콘텐츠 형식 필수 요소. application/json
api-key 필수 요소. api-key는 Search Service 요청을 인증하는 데 사용됩니다. 서비스에 고유한 문자열 값입니다. 시스템 정보에 대한 요청 가져오기에는 쿼리 키가 아닌 관리자 키로 설정된 api-key 필드가 포함되어야 합니다. Azure Portal 검색 서비스 대시보드에서 API 키를 찾을 수 있습니다.

요청 본문

없음

응답

상태 코드: 성공적인 응답을 위해 "200 OK"가 반환됩니다. 응답 본문의 형식은 다음과 같습니다.

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

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

참고 항목