개체 ID로 작업하기

AWS IoT SiteWise 자산, 자산 모델, 속성 및 계층과 같은 다양한 유형의 영구 개체를 정의합니다. 이러한 모든 객체에는 객체를 검색, 업데이트 및 삭제하는 데 사용할 수 있는 고유한 식별자가 있습니다.

AWS IoT SiteWise 고객을 위한 다양한 ID 생성 옵션이 있습니다. AWS IoT SiteWise 객체 생성 시 기본적으로 하나를 생성합니다. 또한 사용자는 개체에 자신의 ID를 제공할 수 있습니다.

개체 UUID로 작업하기

에 있는 모든 영구 AWS IoT SiteWise 개체에는 해당 개체를 식별하는 UUID가 있습니다. 예를 들어 자산 모델에는 자산 모델 ID가 있고 자산에는 자산 ID가 있는 식입니다. 이 ID는 개체를 만들 때 할당되며 개체의 수명 기간 동안 변경되지 않습니다.

새 개체를 만들면 기본적으로 고유한 ID가 AWS IoT SiteWise 생성됩니다. 생성 시 UUID 형식으로 자체 ID를 제공할 수도 있습니다.

참고

UUID는 생성된 AWS 지역 내에서, 그리고 동일한 객체 유형에 대해 전체적으로 고유해야 합니다. AWS IoT SiteWise 자동으로 생성되는 ID는 항상 고유합니다. 고유한 ID를 선택하는 경우 고유한 ID인지 확인하세요.

예를 들어 Model을 호출하여 새 자산 CreateAsset모델을 만드는 경우 요청의 선택적 assetModelId 필드에 고유한 UUID를 제공할 수 있습니다.

반대로 assetModelId 요청에서 생략하면 새 자산 모델에 대한 UUID가 AWS IoT SiteWise 생성됩니다.

외부 ID 사용

UUID가 아닌 다른 형식으로 자체 ID를 정의하려면 외부 ID를 할당할 수 있습니다. 예를 들어, 사용하지 않는 AWS시스템에서 사용 중인 ID를 재사용하거나 사람이 더 쉽게 읽을 수 있도록 하려면 이 작업을 수행할 수 있습니다. 외부 ID는 형식이 더 유연합니다. 다른 방법으로는 UUID를 사용하는 AWS IoT SiteWise API 작업에서 객체를 참조하는 데 이를 사용할 수 있습니다.

UUID와 마찬가지로 각 외부 ID는 컨텍스트 내에서 고유해야 합니다. 예를 들어, 동일한 외부 ID를 가진 두 개의 자산 모델을 가질 수 없습니다. 또한 UUID와 마찬가지로 개체는 수명 주기 동안 외부 ID를 하나만 가질 수 있으며 이는 변경할 수 없습니다.

외부 ID와 UUID 간의 차이점

외부 ID는 다음과 같은 점에서 UUID와 다릅니다.

• 모든 개체에는 UUID가 있지만 외부 ID는 선택 사항입니다.

• AWS IoT SiteWise 외부 ID를 생성하지 않습니다. 이러한 정보는 사용자가 직접 제공합니다.

• 개체에 아직 외부 ID가 없는 경우 언제든지 외부 ID를 할당할 수 있습니다.

외부 ID의 형식

유효한 외부 ID에는 다음과 같은 속성이 있습니다.

• 길이는 2자에서 128자 사이입니다.

• 첫 글자와 마지막 문자는 영숫자 (A-Z, a-z, 0-9) 여야 합니다.

• 첫 번째와 마지막 이외의 문자는 영숫자이거나 다음 중 하나여야 합니다. _-.:

예를 들어 외부 ID는 다음 정규 표현식을 준수해야 합니다.

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

외부 ID를 사용하여 개체 참조

UUID를 사용하여 객체를 참조할 수 있는 곳에서는 외부 ID가 있는 경우 외부 ID를 대신 사용할 수 있습니다. 이렇게 하려면 문자열에 외부 ID를 추가합니다. externalId:

예를 들어 UUID (자산 모델 ID) 가 a1b2c3d4-5678-90ab-cdef-11111EXAMPLE 있고 외부 ID도 있는 자산 모델이 있다고 가정해 보겠습니다. myExternalId DescribeAsset모델에 대한 세부 정보를 얻으려면 모델을 호출하십시오. 다음 중 하나를 값으로 사용할 수 있습니다assetModelId.

• 자산 모델 ID (UUID) 자체 사용: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE

• 외부 ID 사용 시: 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

참고

externalId:접두사 자체는 외부 ID의 일부가 아닙니다. UUID 또는 외부 ID를 허용하는 API 작업에 외부 ID를 제공할 때만 접두사를 제공하면 됩니다. 예를 들어 기존 객체를 쿼리하거나 업데이트할 때 접두사를 제공하십시오.

자산 모델을 만들 때와 같이 개체의 외부 ID를 정의할 때는 접두사를 포함하지 마십시오.

이러한 방식으로 UUID 대신 외부 ID를 사용할 수 있지만 전부는 아닌 많은 API 작업에 사용할 수 있습니다. AWS IoT SiteWise예를 GetAssetPropertyValue들어 는 UUID를 사용해야 하며 외부 ID 사용을 지원하지 않습니다.

특정 API 작업에서 이 사용을 지원하는지 확인하려면 API 참조를 참조하십시오.