View a markdown version of this page

Einrichten AWS IoT SiteWise Objekt-IDs - AWS IoT SiteWise

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Einrichten AWS IoT SiteWise Objekt-IDs

AWS IoT SiteWise definiert verschiedene Typen persistenter Objekte, wie Assets, Asset-Modelle, Eigenschaften und Hierarchien. Alle diese Objekte haben eindeutige Identifikatoren, die Sie verwenden können, um sie abzurufen, zu aktualisieren und zu löschen.

AWS IoT SiteWise bietet Kunden verschiedene Optionen für die ID-Erstellung. AWS IoT SiteWise generiert standardmäßig eine für Sie bei der Objekterstellung. Benutzer können Ihren Objekten auch ihre eigenen IDs geben.

Arbeiten Sie mit Objekt-UUIDs

Jedes persistente Objekt in AWS IoT SiteWise hat eine UUID, um es zu identifizieren. Beispielsweise haben Assetmodelle eine Assetmodell-ID, Assets haben eine Asset-ID und so weiter. Diese ID wird bei der Erstellung des Objekts zugewiesen und bleibt während der gesamten Lebensdauer des Objekts unverändert.

Wenn Sie ein neues Objekt erstellen, AWS IoT SiteWise generiert standardmäßig eine eindeutige ID für Sie. Sie können bei der Erstellung auch Ihre eigene ID im UUID-Format angeben.

Anmerkung

UUIDs müssen innerhalb der AWS Region, in der sie erstellt wurden, und für denselben Objekttyp global eindeutig sein. Wenn eine ID AWS IoT SiteWise automatisch für Sie generiert wird, ist sie immer eindeutig. Wenn Sie Ihre eigene ID wählen, stellen Sie sicher, dass sie eindeutig ist.

Wenn Sie beispielsweise ein neues Asset-Modell per Anruf erstellen CreateAssetModel, können Sie Ihre eigene UUID in das optionale assetModelId Feld der Anfrage eingeben.

Wenn Sie dagegen in der Anfrage nichts angeben, wird assetModelId eine UUID für das neue Asset-Modell AWS IoT SiteWise generiert.

Verwenden Sie externe IDs

Um Ihre eigene ID in einem anderen Format als UUID zu definieren, können Sie eine externe ID zuweisen. Dies können Sie beispielsweise tun, wenn Sie eine ID, die Sie in einem System verwenden, das nicht verwendet wird, wiederverwenden AWS, oder um für Menschen lesbarer zu sein. Externe IDs haben ein flexibleres Format. Sie können sie verwenden, um Ihre Objekte in AWS IoT SiteWise API-Vorgängen zu referenzieren, bei denen Sie sonst die UUID verwenden würden.

Wie die UUIDs muss jede externe ID in ihrem Kontext eindeutig sein. Beispielsweise können Sie nicht zwei Asset-Modelle mit derselben externen ID haben. Ebenso wie die UUIDs kann ein Objekt in seiner Lebensdauer nur eine externe ID haben, die sich nicht ändern kann.

Unterschiede zwischen externen IDs und UUIDs

Externe IDs unterscheiden sich auf folgende Weise von UUIDs:

  • Jedes Objekt hat eine UUID, externe IDs sind jedoch optional.

  • AWS IoT SiteWise generiert niemals externe IDs. Sie stellen diese selbst zur Verfügung.

  • Falls das Objekt noch keine hat, können Sie jederzeit eine externe ID vergeben.

Format der externen IDs

Eine gültige externe ID hat die folgenden Eigenschaften:

  • Ist zwischen 2 und 128 Zeichen lang.

  • Das erste und das letzte Zeichen müssen alphanumerisch sein (A-Z, a-z, 0-9).

  • Alle Zeichen außer dem ersten und letzten müssen entweder alphanumerisch oder eines der folgenden Zeichen sein: _-.:

Eine externe ID muss beispielsweise dem folgenden regulären Ausdruck entsprechen:

[a-zA-Z0-9][a-zA-Z0-9_\-.:]*[a-zA-Z0-9]+

Referenzobjekte mit externen IDs

An vielen Stellen, an denen Sie ein Objekt mithilfe seiner UUID referenzieren könnten, können Sie stattdessen dessen externe ID verwenden, falls es eine hat. Hängen Sie dazu die externe ID an die Zeichenfolge an. externalId:

Angenommen, Sie haben ein Asset-Modell, dessen UUID (Asset Model ID) lauteta1b2c3d4-5678-90ab-cdef-11111EXAMPLE, das auch die externe ID hat. myExternalId Rufen Sie an DescribeAssetModel, um mehr darüber zu erfahren. Sie könnten einen der folgenden Werte als Wert für verwendenassetModelId:

  • Mit der Asset-Model-ID (UUID) selbst: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE

  • Mit der externen ID: externalId:myExternalId

aws iotsitewise describe-asset-model --asset-model-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE aws iotsitewise describe-asset-model --asset-model-id externalId:myExternalId
Anmerkung

Das externalId: Präfix selbst ist nicht Teil der externen ID. Sie müssen das Präfix nur angeben, wenn Sie eine externe ID für einen API-Vorgang angeben, der entweder UUIDs oder externe IDs akzeptiert. Geben Sie das Präfix beispielsweise an, wenn Sie ein vorhandenes Objekt abfragen oder aktualisieren.

Wenn Sie eine externe ID für ein Objekt definieren, z. B. wenn Sie ein Anlagenmodell erstellen, geben Sie das Präfix nicht an.

Auf diese Weise können Sie externe IDs anstelle von UUIDs für viele API-Operationen in verwenden AWS IoT SiteWise, aber nicht für alle. Beispielsweise muss das GetAssetPropertyValue UUIDs verwenden; die Verwendung externer IDs wird nicht unterstützt.

Informationen dazu, ob ein bestimmter API-Vorgang diese Verwendung unterstützt, finden Sie in der API-Referenz.