Configura oggetto IDs - AWS IoT SiteWise
Lavora con oggetti UUIDsUsa esterno IDs

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Configura oggetto IDs

AWS IoT SiteWise definisce vari tipi di oggetti persistenti, come asset, modelli di asset, proprietà e gerarchie. Tutti questi oggetti dispongono di identificatori univoci che è possibile utilizzare per recuperarli, aggiornarli ed eliminarli.

AWS IoT SiteWise offre ai clienti diverse opzioni per la creazione di ID. AWS IoT SiteWise ne genera uno automaticamente per te al momento della creazione dell'oggetto. Gli utenti possono anche fornire i propri dati IDs ai tuoi oggetti.

Lavora con oggetti UUIDs

Ogni oggetto persistente AWS IoT SiteWise ha un codice UUIDper identificarlo. Ad esempio, i modelli di asset hanno un ID del modello di asset, gli asset hanno un ID di asset e così via. Questo ID viene assegnato al momento della creazione dell'oggetto e rimane invariato per tutta la durata dell'oggetto.

Quando crei un nuovo oggetto, per impostazione predefinita AWS IoT SiteWise genera un ID univoco per te. Puoi anche fornire il tuo ID in UUID formato al momento della creazione.

Nota

UUIDsdeve essere univoco a livello globale all'interno AWS della regione in cui è stato creato e per lo stesso tipo di oggetto. Quando AWS IoT SiteWise genera automaticamente un ID per te, è sempre unico. Se scegli il tuo ID, assicurati che sia unico.

Ad esempio, se crei un nuovo modello di asset chiamando CreateAssetModel, puoi fornire il tuo UUID nel assetModelId campo opzionale della richiesta.

Al contrario, se lo ometti assetModelId dalla richiesta, AWS IoT SiteWise genera un modello UUID per il nuovo modello di asset.

Usa esterno IDs

Per definire il proprio ID in un formato diverso da quelloUUID, è possibile assegnare un ID esterno. Ad esempio, puoi farlo se riutilizzi un ID che stai utilizzando in un sistema che non lo è o se desideri renderlo più AWS leggibile dall'uomo. IDsGli esterni hanno un formato più flessibile. È possibile utilizzarli per fare riferimento ai propri oggetti in AWS IoT SiteWise API operazioni in cui altrimenti si utilizzerebbe ilUUID.

Come ilUUIDs, ogni ID esterno deve essere unico nel suo contesto. Ad esempio, non puoi avere due modelli di asset con lo stesso ID esterno. Inoltre, come ilUUIDs, un oggetto può avere un solo ID esterno nel corso della sua vita, che non può cambiare.

Differenze tra esterno IDs e UUIDs

L'esterno IDs si differenzia dai UUIDs seguenti modi:

  • Ogni oggetto ha unUUID, ma gli oggetti esterni IDs sono opzionali.

  • AWS IoT SiteWise non genera mai elementi esterniIDs. Li fornisci tu stesso.

  • Se l'oggetto non ne ha già uno, puoi assegnare un ID esterno in qualsiasi momento.

Formato esterno IDs

Un ID esterno valido ha le seguenti proprietà:

  • Ha una lunghezza compresa tra 2 e 128 caratteri.

  • Il primo e l'ultimo carattere devono essere alfanumerici (A-Z, a-z, 0-9).

  • I caratteri diversi dal primo e dall'ultimo devono essere alfanumerici oppure devono essere uno dei seguenti: _-.:

Ad esempio, un ID esterno deve essere conforme alla seguente espressione regolare:

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

Oggetti di riferimento con oggetti esterni IDs

In molti punti in cui è possibile fare riferimento a un oggetto utilizzandoloUUID, è possibile utilizzare invece il relativo ID esterno, se ne ha uno. A tale scopo, aggiungete l'ID esterno alla stringaexternalId:.

Ad esempio, supponete di avere un modello di asset il cui UUID (ID del modello di asset) èa1b2c3d4-5678-90ab-cdef-11111EXAMPLE, che ha anche l'ID esterno. myExternalId DescribeAssetModelChiamate per avere maggiori dettagli al riguardo. È possibile utilizzare uno dei seguenti valori come valore diassetModelId:

  • Con lo stesso modello di asset ID (UUID): a1b2c3d4-5678-90ab-cdef-11111EXAMPLE

  • Con l'ID esterno: 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
Nota

Il externalId: prefisso, di per sé, non fa parte dell'ID esterno. È necessario fornire il prefisso solo quando si fornisce un ID esterno a un'APIoperazione che accetta uno UUIDs o più elementi esterni. IDs Ad esempio, fornite il prefisso quando interrogate o aggiornate un oggetto esistente.

Quando definite un ID esterno per un oggetto, ad esempio quando create un modello di asset, non includete il prefisso.

È possibile utilizzare external anziché IDs UUIDs in questo modo per molte API operazioni AWS IoT SiteWise, ma non tutte. Ad esempio, il GetAssetPropertyValue, deve usareUUIDs; non supporta l'utilizzo di ID esterni.

Per determinare se una particolare API operazione supporta questo utilizzo, consulta il APIReference.