서비스 통계 가져오기(미리 보기 REST API)

적용 : 2023-07-01-Preview. 이 버전은 더 이상 지원되지 않습니다. 업그레이드는 즉시 최신 버전으로.

중요하다

2023-07-01-Preview는 검색 서비스에 범위가 지정된 vectorIndexSize 추가합니다.

2021-04-30-Preview는 별칭Count추가합니다.

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

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

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

URI 매개 변수

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

요청 헤더

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

필드	묘사
Content-Type	필수. 이 값을 application/json
api-key	Azure 역할 사용하고 요청에 전달자 토큰이 제공된 경우 선택 사항입니다. 그렇지 않으면 키가 필요합니다. api-key는 검색 서비스에 대한 요청을 인증하는 고유한 시스템 생성 문자열입니다. 검색 서비스에 대한 가져오기 요청에는 쿼리 키가 아니라 관리 키로 설정된 api-key 헤더가 포함되어야 합니다. 자세한 내용은 키 인증 사용하여 Azure AI Search에 연결을 참조하세요.

요청 본문

없음.

응답

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

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

통계	형	묘사
documentCount	세다	모든 인덱스의 모든 문서 집계입니다. 초기 버전의 Azure AI Search는 문서 수 제한을 적용했지만 해당 제한은 더 이상 존재하지 않습니다. 할당량은 항상 null이며 서비스에 문서 개수가 무제한일 수 있음을 나타냅니다.
indexesCount	세다	검색 서비스의 인덱스 수입니다. 최대 인덱스는 할당량에 의해 보고된 계층에 따라 다릅니다.
indexersCount	세다	검색 서비스의 인덱서 수입니다. 최대 인덱서는 할당량에 의해 보고된 계층에 따라 다릅니다.
dataSourcesCount	세다	검색 서비스의 데이터 원본 수입니다. 최대 데이터 원본은 할당량에 의해 보고되는 계층에 따라 다릅니다. 최대 데이터 원본은 최대 인덱서와 동일한 수입니다.
aliasesCount	세다	검색 서비스의 인덱스 별칭 수입니다. 최대값은 할당량에 의해 보고된 계층에 따라 다릅니다.
synonymMaps	세다	검색 서비스의 동의어 맵 수입니다. 최대값은 할당량에 의해 보고된 계층에 따라 다릅니다.
storageSize	바이트	사용량은 서비스의 모든 개체에서 사용하는 스토리지 양입니다. 할당량은 서비스에 대해 구성된 파티션의 크기 및 수에 따라 사용 가능한 최대 스토리지입니다. 검색 서비스에 프로비전된 파티션 수에 대한 응답으로 할당량이 증가하고 감소합니다. 파티션 크기는 계층에 따라 다릅니다.
vectorIndexSize	바이트	벡터 인덱스는 내부 구조이며, 검색 인덱스로 정의된 대로 벡터 필드당 하나의 벡터 인덱스입니다. 검색 서비스의 벡터 인덱스 제한을 기준으로 벡터 공간 사용량을 모니터링할 수 있도록 서비스 전체에서 총 사용량이 보고됩니다. 할당량은 검색 서비스의 기간, 파티션 수 및 계층에 따라 결정되는 파티션 크기에 따라 달라집니다.

모든 제한에 대한 자세한 내용은 서비스 제한 참조하세요.

예제

이 API는 데이터 평면입니다. 계층 또는 위치와 같은 서비스에 대한 자세한 내용은 관리 REST API참조하세요.

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

참고 항목

• Azure AI Search REST API