View a markdown version of this page

ConfigurarAWS IoT SiteWiseIDs de objetos - AWS IoT SiteWise

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

ConfigurarAWS IoT SiteWiseIDs de objetos

AWS IoT SiteWisedefine vários tipos de objetos persistentes, como ativos, modelos de ativos, propriedades e hierarquias. Todos esses objetos têm identificadores exclusivos que você pode usar para recuperá-los, atualizá-los e excluí-los.

AWS IoT SiteWisetem opções diferentes para os clientes criarem identidades. AWS IoT SiteWisegera um para você por padrão no momento da criação do objeto. Os usuários também podem fornecer os próprios IDs para os objetos.

Trabalhar com UUIDs de objeto

Cada objeto persistente AWS IoT SiteWise tem um UUID para identificá-lo. Por exemplo, modelos de ativo têm um ID de modelo de ativo, ativos têm um ID de ativo e assim por diante. Esse ID é atribuído no momento em que você cria o objeto e permanece inalterado durante a vida útil do objeto.

Quando você cria um novo objeto, AWS IoT SiteWise gera um ID exclusivo para você por padrão. Você também pode fornecer o próprio ID no momento da criação no formato UUID.

nota

Os UUIDs devem ser globalmente exclusivos na AWS região em que foram criados e para o mesmo tipo de objeto. Quando AWS IoT SiteWise gera automaticamente um ID para você, ele é sempre exclusivo. Se você escolher o próprio ID, garanta que ele seja exclusivo.

Por exemplo, se você criar um novo modelo de ativo chamando CreateAssetModel, poderá fornecer seu próprio UUID no assetModelId campo opcional da solicitação.

Por outro lado, se você omitir assetModelId da solicitação, o AWS IoT SiteWise vai gerar um UUID para o novo modelo de ativo.

Usar IDs externos

Para definir o próprio ID em algum formato diferente de UUID, você pode atribuir um ID externo. Por exemplo, você pode fazer isso se reutilizar um ID que está usando em um sistema que não estáAWS, ou para ser mais legível por humanos. Os IDs externos têm um formato mais flexível. Você pode usá-los para fazer referência aos objetos em operações de API do AWS IoT SiteWise em que, de outra forma, usaria o UUID.

Assim como os UUIDs, cada ID externo deve ser exclusivo dentro do contexto. Por exemplo, não é possível ter dois modelos de ativo com o mesmo ID externo. Além disso, assim como os UUIDs, um objeto só pode ter um ID externo em sua vida útil, que não pode mudar.

Diferenças entre IDs externos e UUIDs

Os IDs externos diferem dos UUIs das seguintes maneiras:

  • Cada objeto tem um UUID, enquanto os IDs externos são opcionais.

  • AWS IoT SiteWisenunca gera IDs externos. Você os fornece por conta própria.

  • Se o objeto ainda não tiver um, você poderá atribuir um ID externo a qualquer momento.

Formato de IDs externos

Um ID externo válido tem as seguintes propriedades:

  • Ele tem entre 2 e 128 caracteres.

  • O primeiro e o último caracteres devem ser alfanuméricos (A-Z, a-z, 0-9).

  • Os demais caracteres devem ser alfanuméricos ou os seguintes: _-.:

Por exemplo, um ID externo deve estar em conformidade com a seguinte expressão regular:

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

Fazer referência a objetos com IDs externos

Em muitos locais em que é possível fazer referência a um objeto usando o UUID, você pode usar o ID externo em vez disso, caso ele tenha um. Para isso, acrescente o ID externo à string externalId:.

Por exemplo, vamos supor que você tenha um modelo de ativo cujo UUID (ID do modelo de ativo) seja a1b2c3d4-5678-90ab-cdef-11111EXAMPLE, que também tem o ID externo myExternalId. Ligue DescribeAssetModelpara obter detalhes sobre isso. Você pode usar qualquer uma das seguintes opções como valor de assetModelId:

  • Com o próprio ID do modelo de ativo (UUID): a1b2c3d4-5678-90ab-cdef-11111EXAMPLE

  • Com o 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

O prefixo externalId: não faz, por si só, parte do ID externo. Você só precisa fornecer o prefixo ao fornecer um ID externo a uma operação de API que aceite UUIDs ou IDs externos. Por exemplo, forneça o prefixo ao consultar ou atualizar um objeto existente.

Ao definir um ID externo para um objeto, como ao criar um modelo de ativo, não inclua o prefixo.

Você pode usar IDs externos no lugar dos UUIDs dessa forma para muitas operações de API emAWS IoT SiteWise, mas não em todas. Por exemplo, o GetAssetPropertyValue, deve usar UUIDs; ele não suporta o uso de ID externo.

Para determinar se uma operação de API específica é compatível com esse uso, consulte a Referência de API.