개요
쿼리 API는 이벤트, 시리즈 및 집계에 대해 각각 하나의 API인 세 개의 REST API로 구성됩니다.
쿼리 API는 선택적 페이지 매김을 사용하여 HTTP GET 요청을 통해 지정된 시간 범위 동안 이벤트 스키마 및 이벤트 수를 반환합니다. 계열 및 집계 계열 정보는 선택적 페이지 매김이 있는 GET 작업을 통해서도 노출됩니다.
| 응용 프로그램 인터페이스 (API) | 설명 |
|---|---|
| 이벤트 API 가져오기 | 검색 범위 및 조건자와 일치하는 원시 이벤트 목록을 반환합니다. |
| 시리즈 API 가져오기 | 모델에 정의되거나 인라인으로 제공된 변수를 통해 유선에 기록된 데이터를 사용하여 캡처된 이벤트에서 Time Series Insights 데이터를 쿼리하고 검색할 수 있습니다. |
| 집계 시리즈 API | 집계 또는 샘플 함수를 사용하여 기록된 데이터를 집계하여 캡처된 이벤트에서 Time Series Insights 데이터를 쿼리하고 검색할 수 있습니다. |
API는 HTTP 요청 JSON 본문을 통해 지정된 다양한 사용자 지정 작업 도 지원합니다. 쿼리 정의는 일반적인 작업에 사용할 수 있습니다.
중요합니다
-
JSON 평면화 및 이스케이프 규칙변경 사항의 일부로, 배열은 동적 형식으로 저장됩니다. 이 형식으로 저장된 페이로드 속성은 오직이벤트 가져오기 API를 통해서만
접근 가능합니다.
오류 응답
쿼리 실행이 실패하면 JSON 응답 페이로드에 다음 구조를 준수하는 오류 응답이 포함됩니다.
{
"error" : {
"code" : "...",
"message" : "...",
"innerError" : {
"code" : "...",
"message" : "...",
}
}
}
여기서는 innerError 선택 사항입니다. 잘못된 형식의 요청과 같은 기본 오류 외에도 다음 오류가 반환됩니다.
| Http 상태 코드 | 오류 코드 | 오류 메시지의 예 | 가능한 innerError 코드 |
|---|---|---|---|
| 400 | 잘못된 API 버전 | API 버전 '2016'은 지원되지 않습니다. 지원되는 버전은 '2016-12-12', '2018-11-01-preview'입니다. | - |
| 400 | InvalidUrl | 요청 URL '/a/b'를 구문 분석할 수 없습니다. | - |
| 400 | 잘못된 입력 | 주어진 쿼리 '집계'가 유효하지 않습니다. 지원되는 쿼리는 'getEvents', 'getSeries', 'aggregateSeries'입니다. | InvalidQueryType |
| 400 | 잘못된 입력 | 'projectedVariables.temperature.value'의 '$event.temperature.Double > 0' 시계열 표현식은 유효한 속성 참조 표현식이 아닙니다. | InvalidPropertyReferenceExpression |
| 400 | 잘못된 입력 | 'projectedVariables.temperature.filter'의 '$event.temperature.Double' 시계열 표현식이 잘못되었습니다. 부울을 반환하는 술어 표현식만 될 수 있습니다. | InvalidPredicateExpression |
| 400 | 잘못된 입력 | 'projectedVariables.temperature.aggregation'의 '$event.temperature.Double' 시계열 표현식이 잘못되었습니다. 집계 표현식이 포함되어 있지 않습니다. | InvalidAggregateExpression |
| 400 | 잘못된 입력 | 'projectedVariables.temperature.value'의 '$event.temperature.Double > 0' 시계열 표현식은 'numeric' 유형의 유효한 값 표현식이 아닙니다. | InvalidValueExpression |
| 400 | 잘못된 입력 | 'projectedVariables.temperature.value'의 값 시계열 표현식은 지정해서는 안 되며 'aggregate' 종류의 변수에 대해 null이어야 합니다. | ValueExpressionShouldNotBe 지정됨 |
| 400 | 잘못된 입력 | 'projectedVariables.temperature.value'의 값 시계열 표현식은 변수 종류 'numeric'에 대해 지정해야 합니다. | ValueExpressionShouldBeSpecified |
| 400 | 잘못된 입력 | 변수 종류 'aggregate'는 'projectedVariables.temperature.aggregation'의 'min($value)' 표현식에 유효하지 않습니다. | 유효하지 않은 변수 종류 |
| 400 | 잘못된 입력 | 'interval'의 시간 범위 '00.00:01'은 유효한 ISO8601 시간 범위 형식이 아닙니다. | InvalidTimeSpanFormat |
| 400 | 잘못된 입력 | timeSeriesId '["ABC123"]' 인스턴스를 찾을 수 없습니다. | 인스턴스 찾지 못함 |
| 400 | 잘못된 입력 | 이름이 'timeSeriesName'인 인스턴스를 찾을 수 없습니다. | 인스턴스 찾지 못함 |
| 400 | 잘못된 입력 | timeSeriesId '["ABC321"]' 인스턴스는 삭제할 수 없습니다. 이 시계열 ID와 연결된 수집된 이벤트가 이미 있습니다. | 인스턴스 삭제 불가 |
| 400 | 잘못된 입력 | ID가 '5e19f688-83fb-4aee-8321-5c123ed016b7'인 환경은 시계열 쿼리 API를 지원하지 않습니다. | TimeSeriesQueryNotSupported(지원 없음) |
| 400 | 잘못된 입력 | 이름이 'temperature'인 프로젝션된 변수가 유형 또는 인라인 변수 정의에서 발견되지 않았습니다. | 투영 변수 발견되지 않음 |
| 400 | 잘못된 입력 | ID가 '7e19g688-83fb-4aee-8321-5c123ed016b7'이고 이름이 'ABC123'인 형식을 upsert 할 수 없습니다. 이 이름은 ID가 '6e19g688-83fb-4aee-8321-5c123ed016b7'인 유형에서 이미 사용되고 있습니다. | NameAlreadyExists |
| 400 | 잘못된 입력 | ID '4e19g688-83fb-4aee-8321-7c123ed016b7' 및 이름 'XYZ123'을 사용하여 계층 구조를 업서트할 수 없습니다. 이 이름은 ID가 '8e39g688-83fb-4aee-8321-5c123ed016b7'인 계층 구조에서 이미 사용됩니다. | HierarchyNotDefined |
| 400 | 잘못된 입력 | 인스턴스 수가 '1,000,000'의 제한을 초과했습니다. | 인스턴스 수 초과 제한 |
| 400 | 잘못된 입력 | 유형 수가 '1000' 제한을 초과했습니다. | 형식 수 초과제한 |
| 400 | 잘못된 입력 | 계층 구조 수가 '32'의 제한을 초과했습니다. | 계층 구조 수 초과 제한 |
| 400 | 잘못된 입력 | 엔터티 크기가 허용되는 최대 크기 '16,384'보다 큽니다. | 개체 크기 초과 제한 |
| 400 | 잘못된 입력 | 길이가 '6'인 오브젝트 이름 'ABC123'이 허용되는 최대 문자 제한인 '5'를 초과합니다. | 이름 초과 제한 |
| 408 | RequestTimeout | '30'초 후에 요청 시간이 초과되었습니다. | BatchRequestSizeExceedededLimit |
| 503 | 요청이 너무 많습니다 | '95880732-01b9-44ea-8d2d-4d764dfe1904'에 대해 '30'의 동시 요청 수를 초과했습니다. | EnvRequestLimit초과 |
참고하십시오
애플리케이션 등록 및 Azure Active Directory 프로그래밍 모델에 대한 자세한 내용은 개발자용 Azure Active Directory를 참조하세요.
요청 및 인증 매개변수에 대한 자세한 내용은 인증 및 권한 부여를 참조하세요.
HTTP 요청 및 응답 테스트를 지원하는 도구는 다음과 같습니다.
바이올린 연주자. 이 무료 웹 디버깅 프록시는 REST 요청을 가로챌 수 있으므로 HTTP 요청 및 응답 메시지를 진단할 수 있습니다.
JWT.io. 이 도구를 사용하여 전달자 토큰의 클레임을 빠르게 덤프한 다음 해당 내용의 유효성을 검사할 수 있습니다.
우체부. REST API 디버깅을 위한 무료 HTTP 요청 및 응답 테스트 도구입니다.
Gen2 설명서를 검토하여 Azure Time Series Insights Gen2에 대해 자세히 알아보세요.