Configura un objeto IDs - AWS IoT SiteWise

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Configura un objeto IDs

AWS IoT SiteWise define varios tipos de objetos persistentes, como activos, modelos de activos, propiedades y jerarquías. Todos estos objetos tienen identificadores únicos que puede utilizar para recuperarlos, actualizarlos y eliminarlos.

AWS IoT SiteWise tiene diferentes opciones para los clientes a la hora de crear identificaciones. AWS IoT SiteWise genera uno por defecto en el momento de la creación del objeto. Los usuarios también pueden proporcionar los suyos propios IDs a sus objetos.

Trabaja con un objeto UUIDs

Cada objeto persistente AWS IoT SiteWise tiene una forma UUIDde identificarlo. Por ejemplo, los modelos de activos tienen un ID de modelo de activo, los activos tienen un ID de activo, etc. Este identificador se asigna en el momento de crear el objeto y permanece inalterado durante la vida útil del objeto.

Cuando creas un objeto nuevo, AWS IoT SiteWise genera un identificador único para ti de forma predeterminada. También puedes proporcionar tu propio ID en el momento de la creación en UUID formato.

nota

UUIDsdebe ser único a nivel mundial en la AWS región en la que se creó y para el mismo tipo de objeto. Cuando se AWS IoT SiteWise genera automáticamente un ID para ti, siempre es único. Si eliges tu propio identificador, asegúrate de que sea único.

Por ejemplo, si llamas para crear un nuevo modelo de activos CreateAssetModel, puedes proporcionar el tuyo propio UUID en el assetModelId campo opcional de la solicitud.

Por el contrario, si lo omites en assetModelId la solicitud, AWS IoT SiteWise genera un UUID para el nuevo modelo de activos.

Utilice una externa IDs

Para definir su propia ID en algún formato que no seaUUID, puede asignar una ID externa. Por ejemplo, puedes hacerlo si reutilizas un ID que estás utilizando en un sistema que no lo está AWS, o si quieres que sea más legible para los humanos. IDsLos externos tienen un formato más flexible. Puede utilizarlos para hacer referencia a sus objetos en AWS IoT SiteWise API operaciones en las que, de otro modo, utilizaría losUUID.

Al igual que elUUIDs, cada ID externo debe ser único dentro de su contexto. Por ejemplo, no puede tener dos modelos de activos con el mismo ID externo. Además, al igual que elUUIDs, un objeto solo puede tener un identificador externo durante su vida útil, que no puede cambiar.

Diferencias entre externo IDs y UUIDs

IDsLas externas se UUIDs diferencian de las siguientes maneras:

  • Cada objeto tiene unUUID, pero IDs los externos son opcionales.

  • AWS IoT SiteWise nunca genera fuentes externasIDs. Los proporciona usted mismo.

  • Si el objeto aún no tiene uno, puedes asignarle un identificador externo en cualquier momento.

Formato de externo IDs

Un identificador externo válido tiene las siguientes propiedades:

  • Tiene una longitud de entre 2 y 128 caracteres.

  • El primer y el último carácter deben ser alfanuméricos (A-Z, a-z, 0-9).

  • Los caracteres que no sean el primero y el último deben ser alfanuméricos o bien alguno de los siguientes caracteres: _-.:

Por ejemplo, un identificador externo debe ajustarse a la siguiente expresión regular:

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

Haga referencia a objetos con objetos externos IDs

En muchos lugares en los que puede hacer referencia a un objeto mediante su IDUUID, puede utilizar su identificador externo en su lugar, si lo tiene. Para ello, añada el ID externo a la cadenaexternalId:.

Por ejemplo, supongamos que tiene un modelo de activo cuyo UUID (ID del modelo de activo) esa1b2c3d4-5678-90ab-cdef-11111EXAMPLE, que también tiene el ID myExternalId externo. Llame DescribeAssetModelpara obtener más información al respecto. Puede utilizar cualquiera de los siguientes valores como valor deassetModelId:

  • Con el propio ID del modelo de activo (UUID): a1b2c3d4-5678-90ab-cdef-11111EXAMPLE

  • Con el ID externo: 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

El externalId: prefijo no forma parte, en sí mismo, del identificador externo. Solo es necesario proporcionar el prefijo cuando se proporciona un identificador externo a una API operación que acepta uno UUIDs u otro externo. IDs Por ejemplo, proporcione el prefijo cuando consulte o actualice un objeto existente.

Al definir un identificador externo para un objeto, por ejemplo, al crear un modelo de activos, no incluya el prefijo.

Puede utilizar el externo IDs en lugar de de de UUIDs esta forma para muchas API operaciones AWS IoT SiteWise, pero no para todas. Por ejemplo GetAssetPropertyValue, debe usarseUUIDs; no admite el uso de identificadores externos.

Para determinar si una API operación en particular admite este uso, consulte la APIReferencia.