Query - Get Event Schema

참조

Service:: Time Series Insights

API Version:: 2020-07-31

지정된 검색 범위에 대한 환경 이벤트 스키마를 반환합니다. 이벤트 스키마는 속성 정의 집합입니다. 속성이 너무 많은 경우 이벤트 스키마에 모든 지속형 속성이 포함되지 않을 수 있습니다.

POST https://{environmentFqdn}/eventSchema?api-version=2020-07-31

With optional parameters:

POST https://{environmentFqdn}/eventSchema?api-version=2020-07-31&storeType={storeType}

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
environmentFqdn	path	True	string	환경별 FQDN(예: 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com) 환경 가져오기 API, Azure Portal 또는 Azure Resource Manager 응답에서 이 도메인 이름을 가져올 수 있습니다.
api-version	query	True	string	클라이언트 요청과 함께 사용할 API의 버전입니다. 현재 지원되는 버전은 "2020-07-31"입니다.
storeType	query		string	웜 저장소를 사용하도록 설정된 환경의 경우 'WarmStore' 또는 'ColdStore'에서 쿼리를 실행할 수 있습니다. 쿼리의 이 매개 변수는 쿼리를 실행해야 하는 저장소를 정의합니다. 정의되지 않은 경우 쿼리는 콜드 저장소에서 실행됩니다.

요청 헤더

Name	필수	형식	Description
x-ms-client-request-id		string	선택적 클라이언트 요청 ID입니다. 서비스는 이 값을 기록합니다. 서비스에서 서비스 간 작업을 추적할 수 있도록 허용하고 고객이 특정 요청과 관련하여 지원에 문의할 수 있도록 허용합니다.
x-ms-client-session-id		string	선택적 클라이언트 세션 ID입니다. 서비스는 이 값을 기록합니다. 서비스에서 서비스 전반의 관련 작업 그룹을 추적할 수 있도록 하고 고객이 특정 요청 그룹에 대한 지원에 문의할 수 있도록 허용합니다.

요청 본문

Name	필수	형식	Description
searchSpan	True	DateTimeRange	쿼리가 실행되는 시간 범위입니다. null일 수 없습니다.

응답

Name	형식	Description
200 OK	EventSchema	작업이 성공했습니다. Headers x-ms-request-id: string
Other Status Codes	TsiError	예기치 않은 오류입니다. Headers x-ms-request-id: string

Name

형식

Description

200 OK

EventSchema

작업이 성공했습니다.

Headers

x-ms-request-id: string

Other Status Codes

TsiError

예기치 않은 오류입니다.

Headers

x-ms-request-id: string

보안

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	사용자 계정 가장

예제

ColdStoreEventSchemaGet

EventSchemaGet

EventSchemaGetEmpty

WarmStoreEventSchemaGet

ColdStoreEventSchemaGet

Sample Request

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/eventSchema?api-version=2020-07-31&storeType=coldstore

{
  "searchSpan": {
    "from": "2018-08-01T00:00:00.000Z",
    "to": "2018-08-31T00:00:00.000Z"
  }
}

Sample Response

Status code:: 200

{
  "properties": [
    {
      "name": "Building",
      "type": "String"
    },
    {
      "name": "Room",
      "type": "String"
    },
    {
      "name": "DeviceId",
      "type": "Double"
    },
    {
      "name": "Temperature",
      "type": "Double"
    },
    {
      "name": "Pressure",
      "type": "Double"
    },
    {
      "name": "Status",
      "type": "String"
    }
  ]
}

EventSchemaGet

Sample Request

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/eventSchema?api-version=2020-07-31

{
  "searchSpan": {
    "from": "2018-08-01T00:00:00.000Z",
    "to": "2018-08-31T00:00:00.000Z"
  }
}

Sample Response

Status code:: 200

{
  "properties": [
    {
      "name": "Building",
      "type": "String"
    },
    {
      "name": "Room",
      "type": "String"
    },
    {
      "name": "DeviceId",
      "type": "Double"
    },
    {
      "name": "Temperature",
      "type": "Double"
    },
    {
      "name": "Pressure",
      "type": "Double"
    },
    {
      "name": "Status",
      "type": "String"
    }
  ]
}

EventSchemaGetEmpty

Sample Request

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/eventSchema?api-version=2020-07-31

{
  "searchSpan": {
    "from": "2016-08-01T00:00:00.000Z",
    "to": "2016-08-31T00:00:00.000Z"
  }
}

Sample Response

Status code:: 200

{
  "properties": []
}

WarmStoreEventSchemaGet

Sample Request

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/eventSchema?api-version=2020-07-31&storeType=warmstore

{
  "searchSpan": {
    "from": "2018-08-01T00:00:00.000Z",
    "to": "2018-08-31T00:00:00.000Z"
  }
}

Sample Response

Status code:: 200

{
  "properties": [
    {
      "name": "Building",
      "type": "String"
    },
    {
      "name": "Room",
      "type": "String"
    },
    {
      "name": "DeviceId",
      "type": "Double"
    },
    {
      "name": "Temperature",
      "type": "Double"
    },
    {
      "name": "Pressure",
      "type": "Double"
    },
    {
      "name": "Status",
      "type": "String"
    }
  ]
}

정의

Name	Description
DateTimeRange	시간 범위입니다. null 또는 음수일 수 없습니다.
EventProperty	저장되거나 계산되는 이벤트의 속성입니다. 속성은 이름과 형식으로 식별됩니다. 다른 이벤트에는 이름이 같지만 형식이 다른 속성이 있을 수 있습니다.
EventSchema	지정된 검색 범위 내의 모든 이벤트의 이벤트 스키마입니다. 이벤트 스키마는 속성 정의 집합입니다. 속성은 이름과 형식으로 식별됩니다. 다른 이벤트에는 이름이 같지만 형식이 다른 속성이 있을 수 있습니다. 속성이 너무 많은 경우 이벤트 스키마에 모든 지속형 속성이 포함되지 않을 수 있습니다.
GetEventSchemaRequest	지정된 검색 범위 내의 모든 이벤트의 이벤트 스키마를 가져오기 위한 요청입니다.
PropertyTypes	속성의 형식입니다.
TsiError	API 오류에 대한 정보입니다.
TsiErrorBody	오류 코드 및 메시지가 있는 특정 API 오류입니다.
TsiErrorDetails	추가 오류 정보입니다.

DateTimeRange

시간 범위입니다. null 또는 음수일 수 없습니다.

Name	형식	Description
from	string	시간 범위의 타임스탬프를 시작합니다. 시작 타임스탬프는 시계열 쿼리 요청에 사용할 때 포함됩니다. 이 타임스탬프가 있는 이벤트가 포함됩니다.
to	string	시간 범위의 끝 타임스탬프입니다. 종료 타임스탬프는 시계열 쿼리 요청에서 사용할 때 배타적입니다. 이 타임스탬프와 일치하는 이벤트는 제외됩니다. 최종 타임스탬프는 Get Availability(이 정확한 "to" 타임스탬프가 있는 이벤트가 있음을 의미)에서 반환할 때 포함됩니다.

EventProperty

저장되거나 계산되는 이벤트의 속성입니다. 속성은 이름과 형식으로 식별됩니다. 다른 이벤트에는 이름이 같지만 형식이 다른 속성이 있을 수 있습니다.

Name	형식	Description
name	string	속성의 이름입니다.
type	PropertyTypes	속성의 형식입니다.

EventSchema

지정된 검색 범위 내의 모든 이벤트의 이벤트 스키마입니다. 이벤트 스키마는 속성 정의 집합입니다. 속성은 이름과 형식으로 식별됩니다. 다른 이벤트에는 이름이 같지만 형식이 다른 속성이 있을 수 있습니다. 속성이 너무 많은 경우 이벤트 스키마에 모든 지속형 속성이 포함되지 않을 수 있습니다.

Name	형식	Description
properties	EventProperty[]	속성 정의 집합입니다. 환경에 데이터가 없으면 반환된 배열이 비어 있습니다.

GetEventSchemaRequest

지정된 검색 범위 내의 모든 이벤트의 이벤트 스키마를 가져오기 위한 요청입니다.

Name	형식	Description
searchSpan	DateTimeRange	쿼리가 실행되는 시간 범위입니다. null일 수 없습니다.

PropertyTypes

속성의 형식입니다.

Name	형식	Description
Bool	string
DateTime	string
Double	string
Long	string
String	string
TimeSpan	string

TsiError

API 오류에 대한 정보입니다.

Name	형식	Description
error	TsiErrorBody	오류 코드 및 메시지가 있는 특정 API 오류입니다.

TsiErrorBody

오류 코드 및 메시지가 있는 특정 API 오류입니다.

Name	형식	Description
code	string	서비스별 오류 코드를 정의하는 언어 독립적이며 사람이 읽을 수 있는 문자열입니다. 이 코드는 응답에 지정된 HTTP 오류 코드에 대한 보다 구체적인 표시기 역할을 합니다. 프로그래밍 방식으로 특정 오류 사례를 처리하는 데 사용할 수 있습니다.
details	TsiErrorDetails[]	추가 오류 정보를 포함합니다. null일 수 있습니다.
innerError	TsiErrorBody	원인을 좁히는 보다 구체적인 오류를 포함합니다. null일 수 있습니다.
message	string	사람이 읽을 수 있는 언어 독립적 오류 표현입니다. 개발자를 돕기 위한 것이며 최종 사용자에게 노출하는 데 적합하지 않습니다.
target	string	특정 오류의 대상입니다(예: 오류의 속성 이름). null일 수 있습니다.

TsiErrorDetails

추가 오류 정보입니다.

Name	형식	Description
code	string	서비스별 오류 코드를 정의하는 언어 독립적이며 사람이 읽을 수 있는 문자열입니다. 이 코드는 응답에 지정된 HTTP 오류 코드에 대한 보다 구체적인 표시기 역할을 합니다. 프로그래밍 방식으로 특정 오류 사례를 처리하는 데 사용할 수 있습니다.
message	string	사람이 읽을 수 있는 언어 독립적 오류 표현입니다. 개발자를 돕기 위한 것이며 최종 사용자에게 노출하는 데 적합하지 않습니다.

Share via

Query - Get Event Schema

URI 매개 변수

요청 헤더

요청 본문

응답

보안

azure_auth

Scopes

예제

ColdStoreEventSchemaGet

Sample Request

Sample Response

EventSchemaGet

Sample Request

Sample Response

EventSchemaGetEmpty

Sample Request

Sample Response

WarmStoreEventSchemaGet

Sample Request

Sample Response

정의

DateTimeRange

EventProperty

EventSchema

GetEventSchemaRequest

PropertyTypes

TsiError

TsiErrorBody

TsiErrorDetails

추가 리소스