Mit Objekt-IDs arbeiten

AWS IoT SiteWise definiert verschiedene Typen persistenter Objekte, wie z. B. Objekte, Objektmodelle, Eigenschaften und Hierarchien. All diese Objekte verfügen über eindeutige Kennungen, mit denen Sie sie abrufen, aktualisieren und löschen können.

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

Mit Objekt-UUIDs arbeiten

Jedes persistente Objekt AWS IoT SiteWise hat eine UUID, um es zu identifizieren. Asset-Modelle haben beispielsweise eine Asset-Modell-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 AWS IoT SiteWise automatisch eine ID für Sie generiert wird, ist sie immer einzigartig. Wenn Sie Ihre eigene ID wählen, stellen Sie sicher, dass sie eindeutig ist.

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

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

Verwendung externer IDs

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

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

Unterschiede zwischen externen IDs und UUIDs

Externe IDs unterscheiden sich in folgenden Punkten 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).

• Andere Zeichen als das erste und das letzte 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]+

Objekte mit externen IDs referenzieren

An vielen Stellen, an denen Sie mithilfe seiner UUID auf ein Objekt verweisen 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:

Nehmen wir beispielsweise an, Sie haben ein Asset-Modell, dessen UUID (Asset Model ID) lauteta1b2c3d4-5678-90ab-cdef-11111EXAMPLE, das auch die externe ID enthält. myExternalId Rufen Sie DescribeAssetModel auf, um weitere Informationen zu erhalten. 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 beispielsweise das Präfix an, wenn Sie ein vorhandenes Objekt abfragen oder aktualisieren.

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

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

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