Bekerja dengan ID objek

AWS IoT SiteWise mendefinisikan berbagai jenis objek persisten, seperti aset, model aset, properti, dan hierarki. Semua objek tersebut memiliki pengidentifikasi unik yang dapat Anda gunakan untuk mengambil, memperbarui, dan menghapusnya.

AWS IoT SiteWise memiliki opsi berbeda untuk pelanggan untuk pembuatan ID. AWS IoT SiteWise menghasilkan satu untuk Anda secara default pada waktu pembuatan objek. Pengguna juga dapat memberikan ID mereka sendiri ke objek Anda.

Bekerja dengan objek UUID

Setiap objek persisten AWS IoT SiteWise memiliki UUID untuk mengidentifikasinya. Misalnya, model aset memiliki ID model aset, aset memiliki ID aset, dan sebagainya. ID ini ditetapkan pada saat Anda membuat objek, dan tetap tidak berubah untuk masa pakai objek.

Saat Anda membuat objek baru, AWS IoT SiteWise buat ID unik untuk Anda secara default. Anda juga dapat memberikan ID Anda sendiri pada waktu pembuatan dalam format UUID.

catatan

UUID harus unik secara global dalam AWS Wilayah tempat ia dibuat, dan untuk jenis objek yang sama. Ketika AWS IoT SiteWise otomatis membuat ID untuk Anda, itu selalu unik. Jika Anda memilih ID Anda sendiri, pastikan itu unik.

Misalnya, jika Anda membuat model aset baru dengan memanggil CreateAssetModel, Anda dapat memberikan UUID Anda sendiri di assetModelId bidang opsional permintaan.

Sebaliknya, jika Anda menghilangkan assetModelId permintaan, AWS IoT SiteWise buat UUID untuk model aset baru.

Menggunakan ID eksternal

Untuk menentukan ID Anda sendiri dalam beberapa format selain UUID, Anda dapat menetapkan ID eksternal. Misalnya, Anda dapat melakukan ini jika Anda menggunakan kembali ID yang Anda gunakan dalam sistem yang tidak AWS, atau agar lebih mudah dibaca manusia. ID eksternal memiliki format yang lebih fleksibel. Anda dapat menggunakannya untuk mereferensikan objek Anda dalam operasi AWS IoT SiteWise API di mana Anda akan menggunakan UUID.

Seperti UUID, setiap ID eksternal harus unik dalam konteksnya. Misalnya, Anda tidak dapat memiliki dua model aset dengan ID eksternal yang sama. Juga, seperti UUID, objek hanya dapat memiliki satu ID eksternal dalam masa hidupnya, yang tidak dapat berubah.

Perbedaan antara ID eksternal dan UUID

ID eksternal berbeda dari UUID dengan cara berikut:

• Setiap objek memiliki UUID, tetapi ID eksternal bersifat opsional.

• AWS IoT SiteWise tidak pernah menghasilkan ID eksternal. Anda menyediakan ini sendiri.

• Jika objek belum memilikinya, Anda dapat menetapkan ID eksternal kapan saja.

Format ID eksternal

ID eksternal yang valid memiliki properti berikut:

• Panjangnya antara 2 dan 128 karakter.

• Karakter pertama dan terakhir harus alfanumerik (A-Z, a-z, 0-9).

• Karakter selain yang pertama dan terakhir harus alfanumerik, atau salah satu dari berikut ini: _-.:

Misalnya, ID eksternal harus sesuai dengan ekspresi reguler berikut:

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

Mereferensikan objek dengan ID eksternal

Di banyak tempat Anda dapat mereferensikan objek menggunakan UUID-nya, Anda dapat menggunakan ID eksternalnya sebagai gantinya, jika ada. Untuk melakukannya, tambahkan ID eksternal ke stringexternalId:.

Misalnya, Anda memiliki model aset yang UUIDnya (ID model aset)a1b2c3d4-5678-90ab-cdef-11111EXAMPLE, yang juga memiliki ID eksternal. myExternalId Hubungi DescribeAssetModel untuk mendapatkan detail tentang hal itu. Anda dapat menggunakan salah satu dari berikut ini sebagai nilaiassetModelId:

• Dengan ID model aset (UUID) itu sendiri: a1b2c3d4-5678-90ab-cdef-11111EXAMPLE

• Dengan ID eksternal: 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

catatan

externalId:Awalan itu sendiri bukan bagian dari ID eksternal. Anda hanya perlu memberikan awalan saat Anda menyediakan ID eksternal ke operasi API yang menerima UUID atau ID eksternal. Misalnya, berikan awalan saat Anda menanyakan atau memperbarui objek yang ada.

Saat Anda menentukan ID eksternal untuk objek, seperti saat Anda membuat model aset, jangan sertakan awalan.

Anda dapat menggunakan ID eksternal sebagai pengganti UUID dengan cara ini untuk banyak operasi API di AWS IoT SiteWise, tetapi tidak semua. Misalnya, GetAssetPropertyValue, harus menggunakan UUID; itu tidak mendukung penggunaan ID eksternal.

Untuk menentukan apakah operasi API tertentu mendukung penggunaan ini, lihat Referensi API.