다음을 통해 공유

Query - Get Availability

  • 참조
서비스:
Time Series Insights
API 버전:
2020-07-31

이벤트 타임스탬프($ts)에 대한 이벤트 수의 시간 범위 및 분포를 반환합니다. 이 API를 사용하여 환경으로 탐색하는 방문 환경을 제공할 수 있습니다.

GET https://{environmentFqdn}/availability?api-version=2020-07-31
선택적 매개 변수: 
GET https://{environmentFqdn}/availability?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
200 OK

AvailabilityResponse

작업이 성공했습니다.

헤더

x-ms-request-id: string
Other Status Codes

TsiError

예기치 않은 오류입니다.

헤더

x-ms-request-id: string

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name Description
user_impersonation 사용자 계정 가장

예제

AvailabilityGet
AvailabilityGetEmpty
ColdStoreAvailabilityGet
WarmStoreAvailabilityGet

AvailabilityGet

샘플 요청

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

샘플 응답

상태 코드:
200 
x-ms-request-id: 0d59d156-2807-4952-87bb-0e074417dbfb
{
  "availability": {
    "intervalSize": "PT1H",
    "distribution": {
      "2019-03-27T04:00:00Z": 432447,
      "2019-03-27T05:00:00Z": 432340,
      "2019-03-27T06:00:00Z": 432451,
      "2019-03-27T07:00:00Z": 432436,
      "2019-03-26T13:00:00Z": 386247,
      "2019-03-27T00:00:00Z": 436968,
      "2019-03-27T01:00:00Z": 432509,
      "2019-03-27T02:00:00Z": 432487
    },
    "range": {
      "from": "2019-03-14T06:38:27.153Z",
      "to": "2019-03-27T03:57:11.697Z"
    }
  }
}

AvailabilityGetEmpty

샘플 요청

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

샘플 응답

상태 코드:
200 
{}

ColdStoreAvailabilityGet

샘플 요청

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

샘플 응답

상태 코드:
200 
x-ms-request-id: 0d59d156-2807-4952-87bb-0e074417dbfb
{
  "availability": {
    "intervalSize": "PT1H",
    "distribution": {
      "2019-03-27T04:00:00Z": 432447,
      "2019-03-27T05:00:00Z": 432340,
      "2019-03-27T06:00:00Z": 432451,
      "2019-03-27T07:00:00Z": 432436,
      "2019-03-26T13:00:00Z": 386247,
      "2019-03-27T00:00:00Z": 436968,
      "2019-03-27T01:00:00Z": 432509,
      "2019-03-27T02:00:00Z": 432487
    },
    "range": {
      "from": "2019-03-14T06:38:27.153Z",
      "to": "2019-03-27T03:57:11.697Z"
    }
  }
}

WarmStoreAvailabilityGet

샘플 요청

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

샘플 응답

상태 코드:
200 
x-ms-request-id: 0d59d156-2807-4952-87bb-0e074417dbfb
{
  "availability": {
    "intervalSize": "PT1H",
    "distribution": {
      "2019-03-27T04:00:00Z": 432447,
      "2019-03-27T05:00:00Z": 432340,
      "2019-03-27T06:00:00Z": 432451,
      "2019-03-27T07:00:00Z": 432436,
      "2019-03-26T13:00:00Z": 386247,
      "2019-03-27T00:00:00Z": 436968,
      "2019-03-27T01:00:00Z": 432509,
      "2019-03-27T02:00:00Z": 432487
    },
    "range": {
      "from": "2019-03-14T06:38:27.153Z",
      "to": "2019-03-27T03:57:11.697Z"
    }
  }
}

정의

Name Description
Availability

환경에 이벤트가 포함된 경우의 이벤트 가용성 정보입니다. 이벤트의 시간 범위와 시간에 따른 이벤트의 대략적 분포를 포함합니다.
AvailabilityResponse

가용성 가져오기 작업의 응답입니다. 환경에 데이터가 없는 경우 가용성 속성은 null입니다.
DateTimeRange

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

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

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

추가 오류 정보입니다.

Availability

환경에 이벤트가 포함된 경우의 이벤트 가용성 정보입니다. 이벤트의 시간 범위와 시간에 따른 이벤트의 대략적 분포를 포함합니다.

Name 형식 Description
distribution

object

intervalSize

string

반환된 이벤트 분포의 간격 크기입니다. 반환된 간격은 적절한 수의 포인트를 반환하도록 선택됩니다. 모든 간격은 크기가 같습니다. 유선 간격은 ISO-8601 기간 형식으로 지정됩니다. 한 달은 항상 30일로 변환되고 1년은 항상 365일입니다. 예: 1분은 "PT1M", 1밀리초는 "PT0.001S"입니다. 자세한 내용은 https://www.w3.org/TR/xmlschema-2/#duration을 참조하세요.
range

DateTimeRange

이벤트 타임스탬프($ts) 속성의 최소 및 최대값입니다.

AvailabilityResponse

가용성 가져오기 작업의 응답입니다. 환경에 데이터가 없는 경우 가용성 속성은 null입니다.

Name 형식 Description
availability

Availability

환경에 이벤트가 포함된 경우의 이벤트 가용성 정보입니다. 환경에 아직 데이터가 없는 경우 이 속성은 null이거나 존재하지 않습니다.

DateTimeRange

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

Name 형식 Description
from

string

시간 범위의 타임스탬프를 시작합니다. 시작 타임스탬프는 시계열 쿼리 요청에 사용할 때 포함됩니다. 이 타임스탬프가 있는 이벤트가 포함됩니다.
to

string

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

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

사람이 읽을 수 있는 언어 독립적 오류 표현입니다. 개발자를 돕기 위한 것이며 최종 사용자에게 노출하는 데 적합하지 않습니다.