Sdílet prostřednictvím


Query - Get Availability

Vrátí časový rozsah a distribuci počtu událostí v časovém razítku události ($ts). Toto rozhraní API se dá použít k zajištění cílového prostředí pro navigaci do prostředí.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
environmentFqdn
path True

string

Plně kvalifikovaný název domény prostředí, například 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Tento název domény můžete získat z odpovědi rozhraní GET Environment API, webu Azure Portal nebo Azure Resource Manageru.

api-version
query True

string

Verze rozhraní API, která se má použít s požadavkem klienta. Aktuálně podporovaná verze je 2020-07-31.

storeType
query

string

Pro prostředí s povoleným teplým úložištěm je možné dotaz spustit buď na warmstore, nebo v ColdStore. Tento parametr v dotazu definuje, na kterém úložišti se má dotaz spustit. Pokud není definovaný, dotaz se spustí v studeném úložišti.

Hlavička požadavku

Name Vyžadováno Typ Description
x-ms-client-request-id

string

Volitelné ID požadavku klienta. Služba tuto hodnotu zaznamená. Umožňuje službě trasovat operace napříč službami a umožňuje zákazníkovi kontaktovat podporu ohledně konkrétní žádosti.

x-ms-client-session-id

string

Volitelné ID relace klienta. Služba tuto hodnotu zaznamená. Umožňuje službě trasovat skupinu souvisejících operací napříč službami a umožňuje zákazníkovi kontaktovat podporu týkající se konkrétní skupiny žádostí.

Odpovědi

Name Typ Description
200 OK

AvailabilityResponse

Úspěšná operace.

Hlavičky

x-ms-request-id: string

Other Status Codes

TsiError

Neočekávaná chyba

Hlavičky

x-ms-request-id: string

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

AvailabilityGet
AvailabilityGetEmpty
ColdStoreAvailabilityGet
WarmStoreAvailabilityGet

AvailabilityGet

Ukázkový požadavek

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

Ukázková odpověď

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

Ukázkový požadavek

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

Ukázková odpověď

{}

ColdStoreAvailabilityGet

Ukázkový požadavek

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

Ukázková odpověď

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

Ukázkový požadavek

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

Ukázková odpověď

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

Definice

Name Description
Availability

Informace o dostupnosti událostí, pokud prostředí obsahuje události. Obsahuje časový rozsah událostí a přibližné rozdělení událostí v průběhu času.

AvailabilityResponse

Odpověď operace Získání dostupnosti Pokud prostředí neobsahuje žádná data, vlastnost dostupnosti má hodnotu null.

DateTimeRange

Rozsah času. Nesmí být null nebo záporné.

TsiError

Informace o chybě rozhraní API

TsiErrorBody

Konkrétní chyba rozhraní API s kódem chyby a zprávou

TsiErrorDetails

Další informace o chybě

Availability

Informace o dostupnosti událostí, pokud prostředí obsahuje události. Obsahuje časový rozsah událostí a přibližné rozdělení událostí v průběhu času.

Name Typ Description
distribution

object

intervalSize

string (duration)

Velikost intervalu pro vrácenou distribuci událostí. Vrácený interval je vybrán k vrácení přiměřeného počtu bodů. Všechny intervaly mají stejnou velikost. V intervalu drátu je zadán ve formátu doby trvání ISO-8601. Jeden měsíc se vždy převede na 30 dní a jeden rok je vždy 365 dnů. Příklady: 1 minuta je PT1M, 1 milisekunda je PT0.001S. Další informace najdete v tématu https://www.w3.org/TR/xmlschema-2/#duration

range

DateTimeRange

Minimální a maximální hodnoty vlastnosti časového razítka události ($ts).

AvailabilityResponse

Odpověď operace Získání dostupnosti Pokud prostředí neobsahuje žádná data, vlastnost dostupnosti má hodnotu null.

Name Typ Description
availability

Availability

Informace o dostupnosti událostí, pokud prostředí obsahuje události. Pokud prostředí ještě nemá žádná data, má tato vlastnost hodnotu null nebo není k dispozici.

DateTimeRange

Rozsah času. Nesmí být null nebo záporné.

Name Typ Description
from

string (date-time)

Počáteční časové razítko časového rozsahu Časové razítko spuštění je inkluzivní, pokud se používá v požadavcích dotazů časových řad. Zahrnuté jsou události, které mají toto časové razítko.

to

string (date-time)

Koncové časové razítko časového rozsahu Koncové časové razítko je výhradní, pokud se používá v požadavcích dotazů časových řad. Události, které odpovídají tomuto časovému razítku, jsou vyloučeny. Všimněte si, že koncové časové razítko je inkluzivní, pokud je vráceno získáním dostupnosti (což znamená, že existuje událost s tímto přesným časovým razítkem "komu").

TsiError

Informace o chybě rozhraní API

Name Typ Description
error

TsiErrorBody

Konkrétní chyba rozhraní API s kódem chyby a zprávou

TsiErrorBody

Konkrétní chyba rozhraní API s kódem chyby a zprávou

Name Typ Description
code

string

Jazykově nezávislý řetězec čitelný pro člověka, který definuje kód chyby specifický pro službu. Tento kód slouží jako konkrétnější ukazatel pro kód chyby HTTP zadaný v odpovědi. Dá se použít k programovému zpracování konkrétních případů chyb.

details

TsiErrorDetails[]

Obsahuje další informace o chybě. Může mít hodnotu null.

innerError

TsiErrorBody

Obsahuje konkrétnější chybu, která zužuje příčinu. Může mít hodnotu null.

message

string

Lidskou čitelnost, jazykově nezávislou reprezentaci chyby. Je určena jako pomoc vývojářům a není vhodná pro vystavení koncovým uživatelům.

target

string

Cíl konkrétní chyby (například název vlastnosti v chybě). Může mít hodnotu null.

TsiErrorDetails

Další informace o chybě

Name Typ Description
code

string

Jazykově nezávislý řetězec čitelný pro člověka, který definuje kód chyby specifický pro službu. Tento kód slouží jako konkrétnější ukazatel pro kód chyby HTTP zadaný v odpovědi. Dá se použít k programovému zpracování konkrétních případů chyb.

message

string

Lidskou čitelnost, jazykově nezávislou reprezentaci chyby. Je určena jako pomoc vývojářům a není vhodná pro vystavení koncovým uživatelům.