Query - Get Availability

Referentie

Service:: Time Series Insights

API-versie:: 2020-07-31

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

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

Met optionele 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 ophalen uit het antwoord van de Get Environments-API, Azure Portal of Azure Resource Manager.
api-version	query	True	string	Versie van de API die moet worden gebruikt met de clientaanvraag. Momenteel wordt versie 2020-07-31 ondersteund.
storeType	query		string	Voor de omgevingen waarvoor warme opslag is ingeschakeld, kan de query worden uitgevoerd op de 'WarmStore' of 'ColdStore'. Deze parameter in de query definieert op welke opslag de query moet worden uitgevoerd. Als deze niet is gedefinieerd, wordt de query uitgevoerd op de koude opslag.

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 de 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 met betrekking tot een bepaalde groep aanvragen.

Antwoorden

Name	Type	Description
200 OK	AvailabilityResponse	Geslaagde bewerking. Kopteksten x-ms-request-id: string
Other Status Codes	TsiError	Onverwachte fout. Kopteksten x-ms-request-id: string

Name

Type

Description

200 OK

AvailabilityResponse

Geslaagde bewerking.

Kopteksten

x-ms-request-id: string

Other Status Codes

TsiError

Onverwachte fout.

Kopteksten

x-ms-request-id: string

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

AvailabilityGet

AvailabilityGetEmpty

ColdStoreAvailabilityGet

WarmStoreAvailabilityGet

AvailabilityGet

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 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

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 200

{}

ColdStoreAvailabilityGet

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 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

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

Definities

Name	Description
Availability	Beschikbaarheidsinformatie over gebeurtenissen wanneer de omgeving gebeurtenissen bevat. Bevat het tijdsbereik van gebeurtenissen en de verdeling van gebeurtenissen in de loop van de tijd.
AvailabilityResponse	Antwoord van de bewerking Beschikbaarheid ophalen. Wanneer de omgeving geen gegevens heeft, is 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

Object

Beschikbaarheidsinformatie over gebeurtenissen wanneer de omgeving gebeurtenissen bevat. Bevat het tijdsbereik van gebeurtenissen en de verdeling van gebeurtenissen in de loop van de tijd.

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

AvailabilityResponse

Object

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

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

DateTimeRange

Object

Het tijdsbereik. Kan niet null of negatief zijn.

Name	Type	Description
from	string (date-time)	Begintijdstempel van het tijdsbereik. Begintijdstempel is inclusief bij gebruik in tijdreeksqueryaanvragen. Gebeurtenissen met deze tijdstempel zijn opgenomen.
to	string (date-time)	Eindtijdstempel van het tijdsbereik. Eindtijdstempel is exclusief wanneer deze wordt gebruikt in queryaanvragen van tijdreeksen. Gebeurtenissen die overeenkomen met deze tijdstempel worden uitgesloten. Houd er rekening mee dat de eindtijdstempel inclusief is wanneer deze wordt geretourneerd door Beschikbaarheid ophalen (wat betekent dat er een gebeurtenis is met dit exacte 'naar'-tijdstempel).

TsiError

Object

Informatie over een API-fout.

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

TsiErrorBody

Object

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 om programmatisch specifieke foutcases af te handelen.
details	TsiErrorDetails[]	Bevat aanvullende foutinformatie. Kan null zijn.
innerError	TsiErrorBody	Bevat specifiekere fouten die de oorzaak beperken. Kan null zijn.
message	string	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 in fout). Kan null zijn.

TsiErrorDetails

Object

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 om programmatisch specifieke foutcases af te handelen.
message	string	Leesbare, taalonafhankelijke weergave van de fout. Het is bedoeld als hulpmiddel voor ontwikkelaars en is niet geschikt voor blootstelling aan eindgebruikers.

Delen via

Query - Get Availability

URI-parameters

Aanvraagkoptekst

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

AvailabilityGet

Voorbeeldaanvraag

Voorbeeldrespons

AvailabilityGetEmpty

Voorbeeldaanvraag

Voorbeeldrespons

ColdStoreAvailabilityGet

Voorbeeldaanvraag

Voorbeeldrespons

WarmStoreAvailabilityGet

Voorbeeldaanvraag

Voorbeeldrespons

Definities

Availability

AvailabilityResponse

DateTimeRange

TsiError

TsiErrorBody

TsiErrorDetails

Aanvullende resources