Mengatur objek IDs - AWS IoT SiteWise
Bekerja dengan objek UUIDsGunakan eksternal IDs

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Mengatur objek IDs

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 milik mereka IDs ke objek Anda.

Bekerja dengan objek UUIDs

Setiap objek persisten AWS IoT SiteWise memiliki UUIDuntuk 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 UUID format.

catatan

UUIDsharus 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 menelepon CreateAssetModel, Anda dapat menyediakannya sendiri UUID di assetModelId bidang opsional permintaan.

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

Gunakan eksternal IDs

Untuk menentukan ID Anda sendiri dalam beberapa format selainUUID, 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. Eksternal IDs memiliki format yang lebih fleksibel. Anda dapat menggunakannya untuk mereferensikan objek Anda dalam AWS IoT SiteWise API operasi di mana Anda seharusnya menggunakanUUID.

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

Perbedaan antara eksternal IDs dan UUIDs

Eksternal IDs berbeda dari UUIDs dalam cara-cara berikut:

  • Setiap objek memilikiUUID, tetapi eksternal IDs adalah opsional.

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

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

Format eksternal IDs

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]+

Referensi objek dengan eksternal IDs

Di banyak tempat di mana Anda dapat mereferensikan objek menggunakannyaUUID, Anda dapat menggunakan ID eksternalnya sebagai gantinya, jika ada. Untuk melakukannya, tambahkan ID eksternal ke stringexternalId:.

Misalnya, Anda memiliki model aset yang UUID (ID model aset)a1b2c3d4-5678-90ab-cdef-11111EXAMPLE, yang juga memiliki ID eksternalmyExternalId. Hubungi DescribeAssetModeluntuk 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 ketika Anda memberikan ID eksternal ke API operasi yang menerima salah satu UUIDs atau eksternal. IDs 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 eksternal IDs sebagai pengganti dengan UUIDs cara ini untuk banyak API operasi di AWS IoT SiteWise, tetapi tidak semua. Misalnya, GetAssetPropertyValue, harus menggunakanUUIDs; itu tidak mendukung penggunaan ID eksternal.

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