Query - Get Availability

Referenz

Service:: Time Series Insights

API Version:: 2020-07-31

Gibt den Zeitbereich und die Verteilung der Ereignisanzahl über den Ereigniszeitstempel ($ts) zurück. Diese API kann verwendet werden, um die Navigation zur Umgebung zu ermöglichen.

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

With optional parameters:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
environmentFqdn	path	True	string	FQDN pro Umgebung, z. B. 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Sie können diesen Domänennamen aus der Antwort der Get Environments-API, Azure-Portal oder Azure Resource Manager abrufen.
api-version	query	True	string	Version der API, die mit der Clientanforderung verwendet werden soll. Derzeit wird die Version "2020-07-31" unterstützt.
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, in welchem Speicher die Abfrage ausgeführt werden soll. Wenn nicht definiert, wird die Abfrage im kalten Speicher ausgeführt.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-request-id		string	Optionale Clientanforderungs-ID. Der Dienst zeichnet diesen Wert auf. Ermöglicht dem Dienst die dienstübergreifende Ablaufverfolgung des Vorgangs und ermöglicht es dem Kunden, sich bezüglich einer bestimmten Anforderung an den Support zu wenden.
x-ms-client-session-id		string	Optionale Clientsitzungs-ID. Der Dienst zeichnet diesen Wert auf. Ermöglicht dem Dienst das Nachverfolgen einer Gruppe verwandter Vorgänge über Dienste hinweg und ermöglicht es dem Kunden, den Support bezüglich einer bestimmten Gruppe von Anforderungen zu kontaktieren.

Antworten

Name	Typ	Beschreibung
200 OK	AvailabilityResponse	Erfolgreiche Ausführung Headers x-ms-request-id: string
Other Status Codes	TsiError	Unerwarteter Fehler. Headers x-ms-request-id: string

Name

Typ

Beschreibung

200 OK

AvailabilityResponse

Erfolgreiche Ausführung

Headers

x-ms-request-id: string

Other Status Codes

TsiError

Unerwarteter Fehler.

Headers

x-ms-request-id: string

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Definitionen

Name	Beschreibung
Availability	Informationen zur Ereignisverfügbarkeit, wenn die Umgebung Ereignisse enthält. Enthält den Zeitbereich von Ereignissen und die ungefähre Verteilung der Ereignisse im Zeitverlauf.
AvailabilityResponse	Antwort des Vorgangs "Verfügbarkeit abrufen". Wenn die Umgebung keine Daten enthält, ist die Verfügbarkeitseigenschaft NULL.
DateTimeRange	Der Zeitbereich. 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

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

Name	Typ	Beschreibung
distribution	object
intervalSize	string	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 haben die gleiche Größe. Für das Drahtintervall wird im ISO-8601-Dauerformat angegeben. Ein Monat wird immer in 30 Tage und ein Jahr ist immer 365 Tage. Beispiele: 1 Minute ist "PT1M", 1 Millisekunde 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

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

Der Zeitbereich. Darf nicht NULL oder negativ sein.

Name	Typ	Beschreibung
from	string	Startzeitstempel des Zeitbereichs. Der Startzeitstempel ist inklusive, wenn er in Zeitreihenabfrageanforderungen verwendet wird. Ereignisse, die über diesen Zeitstempel verfügen, werden eingeschlossen.
to	string	Endzeitstempel des Zeitbereichs. Endzeitstempel ist exklusiv, wenn es in Zeitreihenabfrageanforderungen verwendet wird. Ereignisse, die mit diesem Zeitstempel übereinstimmen, werden ausgeschlossen. Beachten Sie, dass der Endzeitstempel inklusive ist, wenn er von Get Availability zurückgegeben wird (was bedeutet, dass ein Ereignis mit genau diesem Zeitstempel "to" vorhanden ist).

TsiError

Informationen zu einem API-Fehler.

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

TsiErrorBody

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

Name	Typ	Beschreibung
code	string	Sprachunabhängige, für Menschen 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. Ist möglicherweise NULL.
innerError	TsiErrorBody	Enthält einen spezifischeren Fehler, der die Ursache eingrenzt. Ist möglicherweise NULL.
message	string	Für Menschen lesbare, sprachunabhängige Darstellung des Fehlers. Es ist als Hilfe für Entwickler gedacht und eignet sich nicht für die Exposition gegenüber Endbenutzern.
target	string	Ziel des bestimmten Fehlers (z. B. der Name der -Eigenschaft im Fehler). Ist möglicherweise NULL.

TsiErrorDetails

Zusätzliche Fehlerinformationen.

Name	Typ	Beschreibung
code	string	Sprachunabhängige, für Menschen 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	Für Menschen lesbare, sprachunabhängige Darstellung des Fehlers. Es ist als Hilfe für Entwickler gedacht und eignet sich nicht für die Exposition gegenüber Endbenutzern.

Freigeben über

Query - Get Availability

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

azure_auth

Scopes

Beispiele

AvailabilityGet

Sample Request

Sample Response

AvailabilityGetEmpty

Sample Request

Sample Response

ColdStoreAvailabilityGet

Sample Request

Sample Response

WarmStoreAvailabilityGet

Sample Request

Sample Response

Definitionen

Availability

AvailabilityResponse

DateTimeRange

TsiError

TsiErrorBody

TsiErrorDetails

Zusätzliche Ressourcen