Query - Get Availability

Referentie

Service:: Time Series Insights

API Version:: 2020-07-31

Retourneert het tijdsbereik en de verdeling van het aantal gebeurtenissen over de tijdstempel van de gebeurtenis ($ts). Deze API kan worden gebruikt om een landingservaring te bieden voor het navigeren naar de omgeving.

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

With optional parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
environmentFqdn	path	True	string	FQDN per omgeving, bijvoorbeeld 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. U kunt deze domeinnaam verkrijgen uit het antwoord van de API Omgevingen ophalen, Azure Portal of Azure Resource Manager.
api-version	query	True	string	Versie van de API die moet worden gebruikt met de clientaanvraag. De momenteel ondersteunde versie is 2020-07-31.
storeType	query		string	Voor de omgevingen waarvoor warm opslaan is ingeschakeld, kan de query worden uitgevoerd op de 'WarmStore' of 'ColdStore'. Deze parameter in de query definieert op welk archief de query moet worden uitgevoerd. Als deze niet is gedefinieerd, wordt de query uitgevoerd in de koelopslag.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-request-id		string	Optionele clientaanvraag-id. Service registreert deze waarde. Hiermee kan de service de bewerking tussen services traceren en kan de klant contact opnemen met ondersteuning met betrekking tot een bepaalde aanvraag.
x-ms-client-session-id		string	Optionele clientsessie-id. Service registreert deze waarde. Hiermee kan de service een groep gerelateerde bewerkingen in verschillende services traceren en kan de klant contact opnemen met de ondersteuning voor een bepaalde groep aanvragen.

Antwoorden

Name	Type	Description
200 OK	AvailabilityResponse	De bewerking is voltooid. Headers x-ms-request-id: string
Other Status Codes	TsiError	Onverwachte fout. Headers x-ms-request-id: string

Name

Type

Description

200 OK

AvailabilityResponse

De bewerking is voltooid.

Headers

x-ms-request-id: string

Other Status Codes

TsiError

Onverwachte fout.

Headers

x-ms-request-id: string

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

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

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

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

Definities

Name	Description
Availability	Informatie over beschikbaarheid van gebeurtenissen wanneer de omgeving gebeurtenissen bevat. Bevat het tijdsbereik van gebeurtenissen en een geschatte verdeling van gebeurtenissen in de tijd.
AvailabilityResponse	Reactie van de bewerking Beschikbaarheid ophalen. Wanneer de omgeving geen gegevens heeft, is de beschikbaarheidseigenschap null.
DateTimeRange	Het tijdsbereik. Kan niet null of negatief zijn.
TsiError	Informatie over een API-fout.
TsiErrorBody	Een bepaalde API-fout met een foutcode en een bericht.
TsiErrorDetails	Aanvullende foutinformatie.

Availability

Informatie over beschikbaarheid van gebeurtenissen wanneer de omgeving gebeurtenissen bevat. Bevat het tijdsbereik van gebeurtenissen en een geschatte verdeling van gebeurtenissen in de tijd.

Name	Type	Description
distribution	object
intervalSize	string	Intervalgrootte voor de geretourneerde verdeling van de gebeurtenissen. Geretourneerd interval wordt geselecteerd om een redelijk aantal punten te retourneren. Alle intervallen hebben dezelfde grootte. Op het draadinterval is opgegeven in iso-8601 duur notatie. Eén maand wordt altijd geconverteerd naar 30 dagen en één jaar is altijd 365 dagen. Voorbeelden: 1 minuut is 'PT1M', 1 milliseconde is 'PT0.001S'. Zie https://www.w3.org/TR/xmlschema-2/#duration voor meer informatie
range	DateTimeRange	Minimum- en maximumwaarden van de eigenschap timestamp ($ts).

AvailabilityResponse

Reactie van de bewerking Beschikbaarheid ophalen. Wanneer de omgeving geen gegevens heeft, is de beschikbaarheidseigenschap null.

Name	Type	Description
availability	Availability	Informatie over beschikbaarheid van gebeurtenissen wanneer de omgeving gebeurtenissen bevat. Wanneer de omgeving nog geen gegevens heeft, is deze eigenschap null of niet aanwezig.

DateTimeRange

Het tijdsbereik. Kan niet null of negatief zijn.

Name	Type	Description
from	string	Begintijdstempel van het tijdsbereik. Start timestamp is inclusief wanneer deze wordt gebruikt in aanvragen voor tijdreeksquery's. Gebeurtenissen met deze tijdstempel worden opgenomen.
to	string	Eindtijdstempel van het tijdsbereik. Eindtijdstempel is exclusief wanneer deze wordt gebruikt in aanvragen voor tijdreeksquery's. Gebeurtenissen die overeenkomen met deze tijdstempel worden uitgesloten. Houd er rekening mee dat eindtijdstempel inclusief is wanneer deze wordt geretourneerd door Beschikbaarheid ophalen (wat betekent dat er een gebeurtenis is met dit exacte 'naar'-tijdstempel).

TsiError

Informatie over een API-fout.

Name	Type	Description
error	TsiErrorBody	Een bepaalde API-fout met een foutcode en een bericht.

TsiErrorBody

Een bepaalde API-fout met een foutcode en een bericht.

Name	Type	Description
code	string	Taalonafhankelijke, door mensen leesbare tekenreeks die een servicespecifieke foutcode definieert. Deze code fungeert als een specifiekere indicator voor de HTTP-foutcode die is opgegeven in het antwoord. Kan worden gebruikt voor het programmatisch afhandelen van specifieke foutgevallen.
details	TsiErrorDetails[]	Bevat aanvullende foutinformatie. Kan null zijn.
innerError	TsiErrorBody	Bevat een specifiekere fout die de oorzaak beperkt. Kan null zijn.
message	string	Door mensen leesbare, taalonafhankelijke weergave van de fout. Het is bedoeld als hulpmiddel voor ontwikkelaars en is niet geschikt voor blootstelling aan eindgebruikers.
target	string	Doel van de specifieke fout (bijvoorbeeld de naam van de eigenschap fout). Kan null zijn.

TsiErrorDetails

Aanvullende foutinformatie.

Name	Type	Description
code	string	Taalonafhankelijke, door mensen leesbare tekenreeks die een servicespecifieke foutcode definieert. Deze code fungeert als een specifiekere indicator voor de HTTP-foutcode die is opgegeven in het antwoord. Kan worden gebruikt voor het programmatisch afhandelen van specifieke foutgevallen.
message	string	Door mensen leesbare, taalonafhankelijke weergave van de fout. Het is bedoeld als hulpmiddel voor ontwikkelaars en is niet geschikt voor blootstelling aan eindgebruikers.

Query - Get Availability

URI-parameters

Aanvraagkoptekst

Antwoorden

Beveiliging

azure_auth

Scopes

Voorbeelden

AvailabilityGet

Sample Request

Sample Response

AvailabilityGetEmpty

Sample Request

Sample Response

ColdStoreAvailabilityGet

Sample Request

Sample Response

WarmStoreAvailabilityGet

Sample Request

Sample Response

Definities

Availability

AvailabilityResponse

DateTimeRange

TsiError

TsiErrorBody

TsiErrorDetails

Aanvullende resources