View a markdown version of this page

Configuración AWS IoT SiteWise ID de objeto - 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.

Configuración AWS IoT SiteWise ID de objeto

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 ofrece diferentes opciones a los clientes para la creación de identificaciones. AWS IoT SiteWise genera uno para ti de forma predeterminada en el momento de la creación del objeto. Los usuarios también pueden proporcionar sus propios ID a sus objetos.

Uso de UUID de objetos

Cada objeto persistente AWS IoT SiteWise tiene un UUID para identificarlo. Por ejemplo, los modelos de activos tienen un ID de modelo de activos, los activos tienen un ID de activo, etc. Este ID 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 ID único para ti de forma predeterminada. También puede proporcionar su propio ID en el momento de la creación en formato UUID.

nota

Los UUID deben ser únicos a nivel mundial en la AWS región en la que se crearon y para el mismo tipo de objeto. Cuando se AWS IoT SiteWise genera automáticamente un ID para ti, siempre es único. Si elige su propio ID, asegúrate de que sea único.

Por ejemplo, si creas un nuevo modelo de activos mediante una llamada CreateAssetModel, puedes proporcionar tu propio UUID en el assetModelId campo opcional de la solicitud.

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

Uso de ID externos

Para definir su propio ID en un formato distinto de UUID, puede asignar un ID externo. Por ejemplo, puedes hacerlo si reutilizas un identificador que estás usando en un sistema que no lo es AWS, o para que sea más legible para los humanos. Los ID externos tienen un formato más flexible. Puede utilizarlos para hacer referencia a sus objetos en las operaciones de la API de AWS IoT SiteWise en las que, de otro modo, utilizaría el UUID.

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

Diferencias entre ID externos y UUID

Los ID externos se diferencian de los UUID en los siguientes aspectos:

  • Cada objeto tiene un UUID, pero los ID externos son opcionales.

  • AWS IoT SiteWise nunca genera identificadores externos. Los proporciona usted mismo.

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

Formato de los ID externos

Un ID externo válido tiene las siguientes propiedades:

  • Tiene 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 alguno de los siguientes: _-.:

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

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

Objetos de referencia con ID externos

En muchos lugares en los que puede hacer referencia a un objeto mediante su UUID, puede utilizar su ID externo en su lugar, si lo tiene. Para ello, añada el ID externo al externalId: de la cadena.

Por ejemplo, supongamos que tiene un modelo de activos cuyo UUID (ID del modelo de activos) es a1b2c3d4-5678-90ab-cdef-11111EXAMPLE, que también tiene el ID externo myExternalId. Llame DescribeAssetModel para obtener detalles al respecto. Puede utilizar cualquiera de los valores siguientes como valor de assetModelId:

  • Con el propio ID del modelo de activos (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 prefijo externalId: no forma parte, en sí mismo, del ID externo. Solo debe proporcionar el prefijo cuando proporcione un ID externo a una operación de la API que acepte UUID o ID externos. Por ejemplo, proporcione el prefijo cuando consulte o actualice un objeto existente.

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

Puedes usar ID externos en lugar de UUID de esta manera en muchas operaciones de API AWS IoT SiteWise, pero no en todas. Por ejemplo GetAssetPropertyValue, debe usar UUID; no admite el uso de ID externos.

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