Query - Get Availability

Referenz

Dienst:: Time Series Insights

API-Version:: 2020-07-31

Gibt den Zeitraum und die Verteilung der Ereignisanzahl über den Ereigniszeitstempel ($ts) zurück. Diese API kann verwendet werden, um die Landungserfahrung beim Navigieren zur Umgebung bereitzustellen.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
environmentFqdn	path	True	string	Pro Umgebungs-FQDN, z. B. 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Sie können diesen Domänennamen aus der Antwort der Get Environments-API, des Azure-Portals oder des Azure Resource Manager abrufen.
api-version	query	True	string	Version der API, die mit der Clientanforderung verwendet werden soll. Derzeit unterstützte Version ist "2020-07-31".
storeType	query		string	Für Umgebungen mit aktiviertem Warmspeicher kann die Abfrage entweder im "WarmStore" oder "ColdStore" ausgeführt werden. Dieser Parameter in der Abfrage definiert, für welchen Speicher die Abfrage ausgeführt werden soll. Wenn sie nicht definiert ist, wird die Abfrage im Kaltspeicher ausgeführt.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-request-id		string	Optionale Clientanforderungs-ID. Dieser Wert wird vom Dienst aufgezeichnet. Ermöglicht dem Dienst das Nachverfolgen des Vorgangs über Dienste hinweg und ermöglicht es dem Kunden, den Support in Bezug auf eine bestimmte Anfrage zu kontaktieren.
x-ms-client-session-id		string	Optionale Clientsitzungs-ID. Dieser Wert wird vom Dienst aufgezeichnet. Ermöglicht dem Dienst die Ablaufverfolgung einer Gruppe verwandter Vorgänge über Dienste hinweg und ermöglicht es dem Kunden, den Support in Bezug auf eine bestimmte Gruppe von Anfragen zu kontaktieren.

Antworten

Name	Typ	Beschreibung
200 OK	AvailabilityResponse	Erfolgreicher Vorgang. Header x-ms-request-id: string
Other Status Codes	TsiError	Unerwarteter Fehler. Header x-ms-request-id: string

Name

Typ

Beschreibung

200 OK

AvailabilityResponse

Erfolgreicher Vorgang.

Header

x-ms-request-id: string

Other Status Codes

TsiError

Unerwarteter Fehler.

Header

x-ms-request-id: string

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

AvailabilityGet

AvailabilityGetEmpty

ColdStoreAvailabilityGet

WarmStoreAvailabilityGet

AvailabilityGet

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

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

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{}

ColdStoreAvailabilityGet

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

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

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
Availability	Informationen zur Ereignisverfügbarkeit, wenn die Umgebung Ereignisse enthält. Enthält den Zeitraum von Ereignissen und die ungefähre Verteilung von Ereignissen im Laufe der Zeit.
AvailabilityResponse	Antwort des Vorgangs "Verfügbarkeit abrufen". Wenn die Umgebung keine Daten enthält, ist die Verfügbarkeitseigenschaft NULL.
DateTimeRange	Der Zeitraum. Darf nicht null oder negativ sein.
TsiError	Informationen zu einem API-Fehler.
TsiErrorBody	Ein bestimmter API-Fehler mit einem Fehlercode und einer Meldung.
TsiErrorDetails	Zusätzliche Fehlerinformationen.

Availability

Objekt

Informationen zur Ereignisverfügbarkeit, wenn die Umgebung Ereignisse enthält. Enthält den Zeitraum von Ereignissen und die ungefähre Verteilung von Ereignissen im Laufe der Zeit.

Name	Typ	Beschreibung
distribution	object
intervalSize	string (duration)	Intervallgröße für die zurückgegebene Verteilung der Ereignisse. Zurückgegebenes Intervall wird ausgewählt, um eine angemessene Anzahl von Punkten zurückzugeben. Alle Intervalle sind die gleiche Größe. Im Drahtintervall wird im ISO-8601-Dauerformat angegeben. Ein Monat wird immer in 30 Tage konvertiert, und ein Jahr ist immer 365 Tage. Beispiele: 1 Minute ist "PT1M", 1 Millisekunden ist "PT0.001S". Weitere Informationen finden Sie unter https://www.w3.org/TR/xmlschema-2/#duration
range	DateTimeRange	Mindest- und Höchstwerte der Ereigniszeitstempeleigenschaft ($ts).

AvailabilityResponse

Objekt

Antwort des Vorgangs "Verfügbarkeit abrufen". Wenn die Umgebung keine Daten enthält, ist die Verfügbarkeitseigenschaft NULL.

Name	Typ	Beschreibung
availability	Availability	Informationen zur Ereignisverfügbarkeit, wenn die Umgebung Ereignisse enthält. Wenn die Umgebung noch keine Daten enthält, ist diese Eigenschaft null oder nicht vorhanden.

DateTimeRange

Objekt

Der Zeitraum. Darf nicht null oder negativ sein.

Name	Typ	Beschreibung
from	string (date-time)	Startzeitstempel des Zeitraums. Der Startzeitstempel ist inklusive, wenn er in Abfrageanforderungen für Zeitreihen verwendet wird. Ereignisse mit diesem Zeitstempel sind enthalten.
to	string (date-time)	Endzeitstempel des Zeitraums. Der Endzeitstempel ist exklusiv, wenn er in Abfrageanforderungen für Zeitreihen verwendet wird. Ereignisse, die diesem Zeitstempel entsprechen, werden ausgeschlossen. Beachten Sie, dass der Endzeitstempel inklusive ist, wenn er von "Get Availability" zurückgegeben wird (d. h., dass ein Ereignis mit diesem exakten "zu"-Zeitstempel vorhanden ist).

TsiError

Objekt

Informationen zu einem API-Fehler.

Name	Typ	Beschreibung
error	TsiErrorBody	Ein bestimmter API-Fehler mit einem Fehlercode und einer Meldung.

TsiErrorBody

Objekt

Ein bestimmter API-Fehler mit einem Fehlercode und einer Meldung.

Name	Typ	Beschreibung
code	string	Sprachunabhängige, lesbare Zeichenfolge, die einen dienstspezifischen Fehlercode definiert. Dieser Code dient als spezifischerer Indikator für den in der Antwort angegebenen HTTP-Fehlercode. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.
details	TsiErrorDetails[]	Enthält zusätzliche Fehlerinformationen. Kann null sein.
innerError	TsiErrorBody	Enthält einen spezifischeren Fehler, der die Ursache einschränkt. Kann null sein.
message	string	Lesbare, sprachunabhängige Darstellung des Fehlers. Es ist als Hilfe für Entwickler gedacht und eignet sich nicht für die Gefährdung von Endbenutzern.
target	string	Ziel des bestimmten Fehlers (z. B. der Name der Eigenschaft im Fehler). Kann null sein.

TsiErrorDetails

Objekt

Zusätzliche Fehlerinformationen.

Name	Typ	Beschreibung
code	string	Sprachunabhängige, lesbare Zeichenfolge, die einen dienstspezifischen Fehlercode definiert. Dieser Code dient als spezifischerer Indikator für den in der Antwort angegebenen HTTP-Fehlercode. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.
message	string	Lesbare, sprachunabhängige Darstellung des Fehlers. Es ist als Hilfe für Entwickler gedacht und eignet sich nicht für die Gefährdung von Endbenutzern.

Freigeben über

Query - Get Availability

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

AvailabilityGet

Beispielanforderung

Beispiel für eine Antwort

AvailabilityGetEmpty

Beispielanforderung

Beispiel für eine Antwort

ColdStoreAvailabilityGet

Beispielanforderung

Beispiel für eine Antwort

WarmStoreAvailabilityGet

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Availability

AvailabilityResponse

DateTimeRange

TsiError

TsiErrorBody

TsiErrorDetails

Zusätzliche Ressourcen