Query - Get Availability

Odwołanie

Usługa:: Time Series Insights

Wersja interfejsu API:: 2020-07-31

Zwraca zakres czasu i rozkład liczby zdarzeń w sygnaturze czasowej zdarzenia ($ts). Ten interfejs API może służyć do zapewnienia środowiska docelowej przechodzenia do środowiska.

GET https://{environmentFqdn}/availability?api-version=2020-07-31

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
environmentFqdn	path	True	string	Na nazwę FQDN środowiska, na przykład 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Tę nazwę domeny można uzyskać z odpowiedzi interfejsu API pobierania środowisk, witryny Azure Portal lub usługi Azure Resource Manager.
api-version	query	True	string	Wersja interfejsu API do użycia z żądaniem klienta. Obecnie obsługiwana wersja to "2020-07-31".
storeType	query		string	W przypadku środowisk z włączonym ciepłym magazynem zapytanie można wykonać na "WarmStore" lub "ColdStore". Ten parametr w zapytaniu definiuje, w którym magazynie ma być wykonywane zapytanie. Jeśli nie zostanie zdefiniowana, zapytanie zostanie wykonane w magazynie zimnym.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-request-id		string	Opcjonalny identyfikator żądania klienta. Usługa rejestruje tę wartość. Umożliwia usłudze śledzenie operacji między usługami i umożliwia klientowi kontaktowanie się z pomocą techniczną w odniesieniu do określonego żądania.
x-ms-client-session-id		string	Opcjonalny identyfikator sesji klienta. Usługa rejestruje tę wartość. Umożliwia usłudze śledzenie grupy powiązanych operacji w usługach i umożliwia klientowi kontaktowanie się z pomocą techniczną w odniesieniu do określonej grupy żądań.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AvailabilityResponse	Operacja zakończona powodzeniem. Nagłówki x-ms-request-id: string
Other Status Codes	TsiError	Nieoczekiwany błąd. Nagłówki x-ms-request-id: string

Nazwa

Typ

Opis

200 OK

AvailabilityResponse

Operacja zakończona powodzeniem.

Nagłówki

x-ms-request-id: string

Other Status Codes

TsiError

Nieoczekiwany błąd.

Nagłówki

x-ms-request-id: string

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

AvailabilityGet

AvailabilityGetEmpty

ColdStoreAvailabilityGet

WarmStoreAvailabilityGet

AvailabilityGet

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

{}

ColdStoreAvailabilityGet

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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"
    }
  }
}

Definicje

Nazwa	Opis
Availability	Informacje o dostępności zdarzeń, gdy środowisko zawiera zdarzenia. Zawiera zakres czasu zdarzeń i przybliżony rozkład zdarzeń w czasie.
AvailabilityResponse	Odpowiedź na operację Uzyskiwanie dostępności. Jeśli środowisko nie ma danych, właściwość dostępności ma wartość null.
DateTimeRange	Zakres czasu. Nie można mieć wartości null ani ujemnej.
TsiError	Informacje o błędzie interfejsu API.
TsiErrorBody	Określony błąd interfejsu API z kodem błędu i komunikatem.
TsiErrorDetails	Dodatkowe informacje o błędzie.

Availability

Objekt

Informacje o dostępności zdarzeń, gdy środowisko zawiera zdarzenia. Zawiera zakres czasu zdarzeń i przybliżony rozkład zdarzeń w czasie.

Nazwa	Typ	Opis
distribution	object
intervalSize	string (duration)	Rozmiar interwału dla zwracanego rozkładu zdarzeń. Zwracany interwał jest wybierany w celu zwrócenia rozsądnej liczby punktów. Wszystkie interwały mają ten sam rozmiar. Interwał przewodu jest określony w formacie czasu trwania ISO-8601. Jeden miesiąc jest zawsze konwertowany na 30 dni, a jeden rok to zawsze 365 dni. Przykłady: 1 minuta to "PT1M", 1 milisekunda to "PT0.001S". Aby uzyskać więcej informacji, zobacz https://www.w3.org/TR/xmlschema-2/#duration
range	DateTimeRange	Minimalne i maksymalne wartości właściwości znacznika czasu zdarzenia ($ts).

AvailabilityResponse

Objekt

Odpowiedź na operację Uzyskiwanie dostępności. Jeśli środowisko nie ma danych, właściwość dostępności ma wartość null.

Nazwa	Typ	Opis
availability	Availability	Informacje o dostępności zdarzeń, gdy środowisko zawiera zdarzenia. Jeśli środowisko nie ma jeszcze danych, ta właściwość ma wartość null lub nie istnieje.

DateTimeRange

Objekt

Zakres czasu. Nie można mieć wartości null ani ujemnej.

Nazwa	Typ	Opis
from	string (date-time)	Znacznik czasu rozpoczęcia zakresu czasu. Znacznik czasu rozpoczęcia jest uwzględniany w przypadku użycia w żądaniach zapytań szeregów czasowych. Uwzględniane są zdarzenia, które mają ten znacznik czasu.
to	string (date-time)	Znacznik czasu zakończenia zakresu czasu. Sygnatura czasowa zakończenia jest wyłączna w przypadku użycia w żądaniach zapytań szeregów czasowych. Zdarzenia pasujące do tego znacznika czasu są wykluczone. Należy pamiętać, że znacznik czasu zakończenia jest uwzględniany w przypadku zwrócenia przez polecenie Pobierz dostępność (co oznacza, że istnieje zdarzenie z tym dokładnym znacznikiem czasu "do").

TsiError

Objekt

Informacje o błędzie interfejsu API.

Nazwa	Typ	Opis
error	TsiErrorBody	Określony błąd interfejsu API z kodem błędu i komunikatem.

TsiErrorBody

Objekt

Określony błąd interfejsu API z kodem błędu i komunikatem.

Nazwa	Typ	Opis
code	string	Niezależny od języka ciąg czytelny dla człowieka, który definiuje kod błędu specyficzny dla usługi. Ten kod służy jako bardziej szczegółowy wskaźnik dla kodu błędu HTTP określonego w odpowiedzi. Może służyć do programowego obsługi określonych przypadków błędów.
details	TsiErrorDetails[]	Zawiera dodatkowe informacje o błędzie. Może mieć wartość null.
innerError	TsiErrorBody	Zawiera bardziej szczegółowy błąd, który zawęża przyczynę. Może mieć wartość null.
message	string	Czytelna dla człowieka, niezależna od języka reprezentacja błędu. Jest ona przeznaczona jako pomoc dla deweloperów i nie jest odpowiednia dla użytkowników końcowych.
target	string	Element docelowy określonego błędu (na przykład nazwa właściwości w błędzie). Może mieć wartość null.

TsiErrorDetails

Objekt

Dodatkowe informacje o błędzie.

Nazwa	Typ	Opis
code	string	Niezależny od języka ciąg czytelny dla człowieka, który definiuje kod błędu specyficzny dla usługi. Ten kod służy jako bardziej szczegółowy wskaźnik dla kodu błędu HTTP określonego w odpowiedzi. Może służyć do programowego obsługi określonych przypadków błędów.
message	string	Czytelna dla człowieka, niezależna od języka reprezentacja błędu. Jest ona przeznaczona jako pomoc dla deweloperów i nie jest odpowiednia dla użytkowników końcowych.

Udostępnij za pośrednictwem

Query - Get Availability

Parametry identyfikatora URI

Nagłówek żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

AvailabilityGet

Przykładowe żądanie

Przykładowa odpowiedź

AvailabilityGetEmpty

Przykładowe żądanie

Przykładowa odpowiedź

ColdStoreAvailabilityGet

Przykładowe żądanie

Przykładowa odpowiedź

WarmStoreAvailabilityGet

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Availability

AvailabilityResponse

DateTimeRange

TsiError

TsiErrorBody

TsiErrorDetails

Dodatkowe zasoby