Time Series Instances - List

Referenz

Dienst:: Time Series Insights

API-Version:: 2020-07-31

Ruft Zeitreiheninstanzen in Seiten ab.

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

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.

Anforderungsheader

Name	Typ	Beschreibung
x-ms-continuation	string	Fortsetzungstoken von der vorherigen Seite der Ergebnisse, um die nächste Seite der Ergebnisse in Aufrufen abzurufen, die Paginierung unterstützen. Um die Ergebnisse der ersten Seite zu erhalten, geben Sie das NULL-Fortsetzungstoken als Parameterwert an. Das zurückgegebene Fortsetzungstoken ist NULL, wenn alle Ergebnisse zurückgegeben wurden und keine nächste Seite mit Ergebnissen vorhanden ist.
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	GetInstancesPage	Erfolgreiche Ausführung Header x-ms-request-id: string
Other Status Codes	TsiError	Unerwarteter Fehler. Header x-ms-request-id: string

Name

Typ

Beschreibung

200 OK

GetInstancesPage

Erfolgreiche Ausführung

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-Flow

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

InstancesListPage1

InstancesListPage2

InstancesListPage3

InstancesListPage1

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "instances": [
    {
      "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
      "name": "F1W7.GS1",
      "timeSeriesId": [
        "006dfc2d-0324-4937-998c-d16f3b4f1952",
        "T1"
      ],
      "description": "ContosoFarm1W7_GenSpeed1",
      "hierarchyIds": [
        "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
      ],
      "instanceFields": {
        "Name": "GeneratorSpeed",
        "Plant": "Contoso Plant 1",
        "Unit": "W7",
        "System": "Generator System",
        "Status": false,
        "Version": 1.3,
        "Code": 28
      }
    }
  ],
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0="
}

InstancesListPage2

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "instances": [
    {
      "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
      "timeSeriesId": [
        "fe984fd0-f632-49ab-990e-3ded259e29b8",
        "T1"
      ],
      "description": "ContosoFarm1W6_GridVoltage3",
      "hierarchyIds": [
        "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
      ],
      "instanceFields": {
        "Name": "GridVoltagePhase3",
        "Plant": "Contoso Plant 1",
        "Unit": "W6",
        "System": "Generator System",
        "Status": false,
        "Version": 1.3,
        "Code": 28
      }
    }
  ],
  "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrASI6MTAwMH0="
}

InstancesListPage3

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "instances": []
}

Definitionen

Name	Beschreibung
GetInstancesPage	Partielle Liste der Zeitreiheninstanzen, die in einer einzelnen Anforderung zurückgegeben werden.
TimeSeriesInstance	Zeitreiheninstanzen sind die Zeitreihen selbst. In den meisten Fällen ist die deviceId oder die assetId der eindeutige Bezeichner des Objekts in der Umgebung. Instanzen verfügen über beschreibende Informationen, die als instance Felder bezeichnet werden. Mindestens instance Felder enthalten Hierarchieinformationen. Sie können auch nützliche, beschreibende Daten enthalten wie Hersteller, Bediener oder letztes Wartungsdatum.
TsiError	Informationen zu einem API-Fehler.
TsiErrorBody	Ein bestimmter API-Fehler mit einem Fehlercode und einer Meldung.
TsiErrorDetails	Zusätzliche Fehlerinformationen.

GetInstancesPage

Partielle Liste der Zeitreiheninstanzen, die in einer einzelnen Anforderung zurückgegeben werden.

Name	Typ	Beschreibung
continuationToken	string	Wenn dies zurückgegeben wird, bedeutet dies, dass aktuelle Ergebnisse ein Teilergebnis darstellen. Fortsetzungstoken ermöglicht das Abrufen der nächsten Seite der Ergebnisse. Um die nächste Seite der Abfrageergebnisse zu erhalten, senden Sie dieselbe Anforderung mit dem Fortsetzungstokenparameter im HTTP-Header "x-ms-continuation".
instances	TimeSeriesInstance[]	Partielle Liste der Zeitreiheninstanzen, die in einer einzelnen Anforderung zurückgegeben werden. Kann leer sein, wenn der Server die Seite in dieser Anforderung nicht ausfüllen konnte oder keine weiteren Objekte vorhanden sind, wenn das Fortsetzungstoken NULL ist.

TimeSeriesInstance

Zeitreiheninstanzen sind die Zeitreihen selbst. In den meisten Fällen ist die deviceId oder die assetId der eindeutige Bezeichner des Objekts in der Umgebung. Instanzen verfügen über beschreibende Informationen, die als instance Felder bezeichnet werden. Mindestens instance Felder enthalten Hierarchieinformationen. Sie können auch nützliche, beschreibende Daten enthalten wie Hersteller, Bediener oder letztes Wartungsdatum.

Name	Typ	Beschreibung
description	string	Dieses optionale Feld enthält eine Beschreibung zum instance.
hierarchyIds	string[]	Satz von Zeitreihenhierarchie-IDs, zu denen die instance gehören. Ist möglicherweise NULL.
instanceFields		Satz von Schlüssel-Wert-Paaren, die benutzerdefinierte instance Eigenschaften enthalten. Dieser kann null sein. Unterstützte Eigenschaftswerttypen sind: bool, string, long, double, und es kann nicht geschachtelt oder NULL sein.
name	string	Optionaler Name des instance, der in einer Umgebung eindeutig ist. Namen fungieren als veränderlicher Alias oder Anzeigename der Zeitreihen instance. Änderbar, kann NULL sein.
timeSeriesId	TimeSeriesId[]	Zeitreihen-ID, die die instance eindeutig identifiziert. Es entspricht Time Series ID-Eigenschaften in einer Umgebung. Unveränderlich, nie NULL.
typeId	string	Dies stellt den Typ dar, zu dem dieser instance gehört. Nie NULL.

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

Time Series Instances - List

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

InstancesListPage1

Beispielanforderung

Beispiel für eine Antwort

InstancesListPage2

Beispielanforderung

Beispiel für eine Antwort

InstancesListPage3

Beispielanforderung

Beispiel für eine Antwort

Definitionen

GetInstancesPage

TimeSeriesInstance

TsiError

TsiErrorBody

TsiErrorDetails

Zusätzliche Ressourcen