Objekt einrichten IDs - AWS IoT SiteWise
Arbeiten Sie mit dem Objekt UUIDsExtern verwenden IDs

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.

Objekt einrichten IDs

AWS IoT SiteWise definiert verschiedene Typen persistenter Objekte, wie z. B. Vermögenswerte, 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 IDs ihre eigenen hinzufügen.

Arbeiten Sie mit dem Objekt UUIDs

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

UUIDsmuss innerhalb der AWS Region, in der es erstellt wurde, global eindeutig sein und für denselben Objekttyp gelten. 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 per Anruf ein neues Asset-Modell erstellen CreateAssetModel, können Sie Ihr eigenes UUID im optionalen assetModelId Feld der Anfrage angeben.

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

Extern verwenden IDs

Um Ihre eigene ID in einem anderen Format als zu definierenUUID, 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 Ihre Objekte bei AWS IoT SiteWise API Operationen zu referenzieren, bei denen Sie sonst die verwenden würdenUUID.

Ebenso wie die UUIDs muss jede externe ID innerhalb ihres Kontextes eindeutig sein. Sie können beispielsweise nicht zwei Asset-Modelle mit derselben externen ID haben. Ebenso wie das UUIDs kann ein Objekt während seiner Lebensdauer nur eine externe ID haben, die sich nicht ändern kann.

Unterschiede zwischen extern IDs und UUIDs

Extern IDs unterscheiden sich UUIDs in folgenden Punkten von:

  • Jedes Objekt hat eineUUID, externe IDs sind jedoch optional.

  • AWS IoT SiteWise generiert niemals externIDs. 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]+

Referenzobjekte mit externen IDs

An vielen Stellen, an denen Sie mit seiner auf ein Objekt verweisen könntenUUID, können Sie stattdessen dessen externe ID verwenden, falls es eine hat. Hängen Sie dazu die externe ID an die Zeichenfolge externalId: an.

Nehmen wir zum Beispiel an, Sie haben ein Asset-Modell, dessen UUID (Asset-Modell-ID) lauteta1b2c3d4-5678-90ab-cdef-11111EXAMPLE, das auch die externe ID myExternalId hat. Rufen Sie DescribeAssetModelan, um weitere Informationen zu erhalten. Sie könnten einen der folgenden Werte als Wert von verwendenassetModelId:

  • Mit der Asset-Modell-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 UUIDs entweder eine externe ID akzeptiertIDs. 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 für viele API Operationen UUIDs in AWS IoT SiteWise, aber nicht für alle, externe IDs anstelle von verwenden. Zum Beispiel muss das GetAssetPropertyValue, verwendenUUIDs; es unterstützt die Verwendung externer IDs nicht.

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