Query - Get Availability

Referens

Service:: Time Series Insights

API Version:: 2020-07-31

Returnerar tidsintervallet och fördelningen av antalet händelser över händelsetidsstämpeln ($ts). Det här API:et kan användas för att ge en landningsupplevelse när du navigerar till miljön.

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

With optional parameters:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
environmentFqdn	path	True	string	FQDN per miljö, till exempel 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Du kan hämta det här domännamnet från svaret från GET Environments API, Azure Portal eller Azure Resource Manager.
api-version	query	True	string	Version av API:et som ska användas med klientbegäran. Den version som stöds för närvarande är "2020-07-31".
storeType	query		string	För miljöer med varmt arkiv aktiverat kan frågan köras antingen på "WarmStore" eller "ColdStore". Den här parametern i frågan definierar vilket lager frågan ska köras på. Om den inte har definierats körs frågan i det kalla arkivet.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string	Valfritt klientbegärans-ID. Tjänsten registrerar det här värdet. Tillåter att tjänsten spårar åtgärder mellan tjänster och gör att kunden kan kontakta supporten angående en viss begäran.
x-ms-client-session-id		string	Valfritt klientsessions-ID. Tjänsten registrerar det här värdet. Gör att tjänsten kan spåra en grupp relaterade åtgärder mellan tjänster och gör att kunden kan kontakta supporten för en viss grupp med begäranden.

Svar

Name	Typ	Description
200 OK	AvailabilityResponse	Åtgärden lyckades. Headers x-ms-request-id: string
Other Status Codes	TsiError	Oväntat fel. Headers x-ms-request-id: string

Name

Typ

Description

200 OK

AvailabilityResponse

Åtgärden lyckades.

Headers

x-ms-request-id: string

Other Status Codes

TsiError

Oväntat fel.

Headers

x-ms-request-id: string

Säkerhet

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	personifiera ditt användarkonto

Exempel

AvailabilityGet

AvailabilityGetEmpty

ColdStoreAvailabilityGet

WarmStoreAvailabilityGet

AvailabilityGet

Sample Request

HTTP

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

Sample Response

Status code:: 200

x-ms-request-id: 0d59d156-2807-4952-87bb-0e074417dbfb

Response Body

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

Sample Request

HTTP

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

Sample Response

Status code:: 200

{}

ColdStoreAvailabilityGet

Sample Request

HTTP

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

Sample Response

Status code:: 200

x-ms-request-id: 0d59d156-2807-4952-87bb-0e074417dbfb

Response Body

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

Sample Request

HTTP

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

Sample Response

Status code:: 200

x-ms-request-id: 0d59d156-2807-4952-87bb-0e074417dbfb

Response Body

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

Definitioner

Name	Description
Availability	Information om händelsetillgänglighet när miljön innehåller händelser. Innehåller tidsintervall för händelser och ungefärlig fördelning av händelser över tid.
AvailabilityResponse	Svar från åtgärden Hämta tillgänglighet. När miljön saknar data är tillgänglighetsegenskapen null.
DateTimeRange	Tidsintervallet. Får inte vara null eller negativt.
TsiError	Information om ett API-fel.
TsiErrorBody	Ett visst API-fel med en felkod och ett meddelande.
TsiErrorDetails	Ytterligare felinformation.

Availability

Information om händelsetillgänglighet när miljön innehåller händelser. Innehåller tidsintervall för händelser och ungefärlig fördelning av händelser över tid.

Name	Typ	Description
distribution	object
intervalSize	string	Intervallstorlek för den returnerade fördelningen av händelserna. Returnerat intervall väljs för att returnera ett rimligt antal punkter. Alla intervall har samma storlek. På trådintervallet anges i ISO-8601-varaktighetsformat. En månad konverteras alltid till 30 dagar och ett år är alltid 365 dagar. Exempel: 1 minut är "PT1M", 1 millisekunder är "PT0.001S". För ytterligare information, se https://www.w3.org/TR/xmlschema-2/#duration
range	DateTimeRange	Minsta och högsta värden för händelsetidsstämpelegenskapen ($ts).

AvailabilityResponse

Svar från åtgärden Hämta tillgänglighet. När miljön saknar data är tillgänglighetsegenskapen null.

Name	Typ	Description
availability	Availability	Information om händelsetillgänglighet när miljön innehåller händelser. När miljön inte har några data ännu är den här egenskapen null eller finns inte.

DateTimeRange

Tidsintervallet. Får inte vara null eller negativt.

Name	Typ	Description
from	string	Starttidsstämpel för tidsintervallet. Starttidsstämpeln är inkluderande när den används i frågebegäranden för tidsserier. Händelser som har den här tidsstämpeln ingår.
to	string	Sluttidsstämpel för tidsintervallet. Sluttidsstämpeln är exklusiv när den används i frågebegäranden i tidsserier. Händelser som matchar den här tidsstämpeln undantas. Observera att sluttidsstämpeln är inkluderande när den returneras av Hämta tillgänglighet (vilket innebär att det finns en händelse med den här exakta "till"-tidsstämpeln).

TsiError

Information om ett API-fel.

Name	Typ	Description
error	TsiErrorBody	Ett visst API-fel med en felkod och ett meddelande.

TsiErrorBody

Ett visst API-fel med en felkod och ett meddelande.

Name	Typ	Description
code	string	Språkoberoende, läsbar sträng som definierar en tjänstspecifik felkod. Den här koden fungerar som en mer specifik indikator för HTTP-felkoden som anges i svaret. Kan användas för att programmatiskt hantera specifika felfall.
details	TsiErrorDetails[]	Innehåller ytterligare felinformation. Kan vara null.
innerError	TsiErrorBody	Innehåller mer specifika fel som begränsar orsaken. Kan vara null.
message	string	Mänsklig läsbar, språkoberoende representation av felet. Det är avsett som ett stöd för utvecklare och är inte lämpligt för exponering för slutanvändare.
target	string	Mål för det specifika felet (till exempel namnet på egenskapen i fel). Kan vara null.

TsiErrorDetails

Ytterligare felinformation.

Name	Typ	Description
code	string	Språkoberoende, läsbar sträng som definierar en tjänstspecifik felkod. Den här koden fungerar som en mer specifik indikator för HTTP-felkoden som anges i svaret. Kan användas för att programmatiskt hantera specifika felfall.
message	string	Mänsklig läsbar, språkoberoende representation av felet. Det är avsett som ett stöd för utvecklare och är inte lämpligt för exponering för slutanvändare.

Share via

Query - Get Availability

URI-parametrar

Begärandehuvud

Svar

Säkerhet

azure_auth

Scopes

Exempel

AvailabilityGet

Sample Request

Sample Response

AvailabilityGetEmpty

Sample Request

Sample Response

ColdStoreAvailabilityGet

Sample Request

Sample Response

WarmStoreAvailabilityGet

Sample Request

Sample Response

Definitioner

Availability

AvailabilityResponse

DateTimeRange

TsiError

TsiErrorBody

TsiErrorDetails

Ytterligare resurser