Lavorare con gli ID degli oggetti

AWS IoT SiteWise definisce vari tipi di oggetti persistenti, come risorse, modelli di risorse, 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 ID agli oggetti.

Lavorare con gli UUID degli oggetti

Ogni oggetto persistente AWS IoT SiteWise ha un UUID per 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 al momento della creazione in formato UUID.

Nota

Gli UUID devono essere univoci a livello globale all'interno della AWS regione in cui sono stati creati 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 si omette assetModelId dalla richiesta, AWS IoT SiteWise genera un UUID per il nuovo modello di asset.

Utilizzo di ID esterni

Per definire il proprio ID in un formato diverso dall'UUID, è 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. Gli ID esterni hanno un formato più flessibile. Puoi usarli per fare riferimento ai tuoi oggetti nelle operazioni AWS IoT SiteWise API in cui altrimenti utilizzeresti l'UUID.

Come gli UUID, 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 gli UUID, un oggetto può avere un solo ID esterno nel corso della sua vita, che non può cambiare.

Differenze tra ID esterni e UUID

Gli ID esterni differiscono dagli UUID nei seguenti modi:

• Ogni oggetto ha un UUID, ma gli ID esterni sono opzionali.

• AWS IoT SiteWise non genera mai ID esterni. Li fornisci tu stesso.

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

Formato degli ID esterni

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]+

Riferimento a oggetti con ID esterni

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

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

• Con lo stesso Asset Model 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'operazione API che accetta UUID o ID esterni. 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.

In questo modo potete utilizzare ID esterni al posto degli UUID per molte operazioni API in AWS IoT SiteWise, ma non per tutte. Ad esempio, GetAssetPropertyValue, deve utilizzare gli UUID; non supporta l'utilizzo di ID esterni.

Per determinare se una particolare operazione API supporta questo utilizzo, consulta l'API Reference.