Tabel berikut menjelaskan operasi API yang tersedia untuk digunakan di IoT Platform.
Produk
| API | Deskripsi |
| CreateProduct | Membuat produk. |
| UpdateProduct | Memodifikasi informasi tentang suatu produk. |
| QueryProductList | Mengajukan pertanyaan tentang produk. |
| QueryProduct | Mengkueri detail suatu produk. |
| DeleteProduct | Menghapus sebuah produk. |
| CreateProductTags | Membuat tag produk. |
| UpdateProductTags | Memodifikasi tag dari sebuah produk. |
| DeleteProductTags | Menghapus tag produk. |
| ListProductTags | Mengambil semua tag dari sebuah produk. |
| ListProductByTags | Mengajukan pertanyaan produk berdasarkan tag. |
| UpdateProductFilterConfig | Memodifikasi aturan deduplikasi untuk pesan properti yang dikirimkan oleh perangkat dari suatu produk. |
| ReleaseProduct | Menerbitkan sebuah produk. |
| CancelReleaseProduct | Menghapus publikasi sebuah produk. |
Perangkat
| API | Deskripsi |
| RegisterDevice | Mendaftarkan perangkat. |
| QueryClientIds | Mengambil ClientID perangkat. Operasi API ini didukung untuk verifikasi unik-sertifikat-per-produk tanpa pra-pendaftaran. |
| TransformClientId | Menentukan ClientID yang valid untuk perangkat guna mencegah login tidak sah jika perangkat memiliki beberapa ClientID. Operasi API ini didukung untuk verifikasi unik-sertifikat-per-produk tanpa pra-pendaftaran. |
| DeleteClientIds | Menghapus semua ClientID perangkat jika jumlah ClientID melebihi batas (5). Operasi API ini didukung untuk verifikasi unik-sertifikat-per-produk tanpa pra-pendaftaran. |
| QueryDeviceInfo | Mengambil informasi dasar tentang perangkat. Informasi tersebut mencakup ID perangkat, sertifikat perangkat, dan alias. |
| QueryDeviceDetail | Mengambil detail perangkat. |
| BatchQueryDeviceDetail | Mengambil detail dari beberapa perangkat. |
| QueryDevice | Meminta informasi perangkat dari sebuah produk. |
| DeleteDevice | Menghapus perangkat. |
| GetDeviceStatus | Memeriksa status perangkat. |
| BatchGetDeviceState | Memeriksa status perangkat. |
| DisableThing | Menonaktifkan perangkat. |
| EnableThing | Mengaktifkan perangkat yang dinonaktifkan. |
| ResetThing | Mengatur ulang perangkat. |
| BatchCheckDeviceNames | Menentukan nama untuk beberapa perangkat sekaligus. IoT Platform memeriksa apakah nama-nama tersebut valid. |
| BatchRegisterDeviceWithApplyId | Mendaftarkan beberapa perangkat sekaligus dengan menggunakan ID aplikasi. |
| BatchRegisterDevice | Mendaftarkan beberapa perangkat sekaligus. |
| QueryBatchRegisterDeviceStatus | Memeriksa status pemrosesan pendaftaran untuk beberapa perangkat. |
| QueryPageByApplyId | Mengajukan permintaan ke beberapa perangkat berdasarkan ID aplikasi. |
| SaveDeviceProp | Membuat tag untuk perangkat. |
| QueryDeviceProp | Mengambil tag dari sebuah perangkat. |
| DeleteDeviceProp | Menghapus tag-tag dari sebuah perangkat. |
| GetThingTopo | Mengquery sub-perangkat dari perangkat gateway. |
| NotifyAddThingTopo | Memberi tahu perangkat gateway untuk membangun hubungan topologis dengan sub-perangkat. |
| BatchAddThingTopo | Membangun hubungan topologi antara beberapa sub-perangkat dan perangkat gateway. |
| RemoveThingTopo | Menghapus hubungan topologi dari sebuah perangkat. |
| QueryDeviceStatistics | Mengajukan statistik perangkat. |
| GetGatewayBySubDevice | Mengambil informasi tentang perangkat gateway berdasarkan informasi sub-perangkat. |
| QueryDeviceByTags | Mengajukan kueri perangkat berdasarkan tag. |
| QueryDeviceFileList | Mengambil file yang diunggah ke IoT Platform dari perangkat. |
| QueryDeviceFile | Mengambil detail file yang diunggah ke IoT Platform dari perangkat. |
| DeleteDeviceFile | Menghapus file yang diunggah ke IoT Platform dari perangkat. |
| BatchUpdateDeviceNickname | Memodifikasi alias dari beberapa perangkat. |
| QueryDeviceByStatus | Mengajukan kueri perangkat berdasarkan status. |
| ListOTAModuleVersionsByDevice | Meminta versi modul over-the-air (OTA). Versi tersebut dikirimkan oleh perangkat. |
| ImportDevice | Menambahkan perangkat ke produk gateway MQTT. |
| BatchImportDevice | Menambahkan beberapa perangkat ke produk gateway MQTT sekaligus. |
| BatchCheckImportDevice | Memverifikasi beberapa perangkat yang ditambahkan ke produk gateway MQTT sekaligus. |
| QueryImportedDeviceByApplyId | Mengambil beberapa perangkat yang ditambahkan sekaligus berdasarkan ID aplikasi. |
| BatchImportVehicleDevice | Menambahkan beberapa perangkat ke produk gateway JT/T 808 sekaligus. |
| BatchCheckVehicleDevice | Memverifikasi beberapa perangkat yang ditambahkan ke produk gateway JT/T 808 sekaligus. |
| QueryVehicleDevice | Mengambil informasi tentang perangkat dari produk gateway JT/T 808. |
Distribusi Perangkat
| API | Deskripsi |
| CreateDeviceDistributeJob | Membuat tugas untuk mendistribusikan perangkat. Produk yang dimiliki perangkat juga didistribusikan. |
| CreateProductDistributeJob | Membuat tugas untuk mendistribusikan produk ke instance. |
| QueryDeviceDistributeDetail | Memeriksa hasil dari tugas distribusi perangkat. |
| QueryDeviceDistributeJob | Memeriksa detail dari tugas distribusi perangkat. |
| ListDeviceDistributeJob | Memeriksa tugas distribusi perangkat. |
| DeleteDeviceDistributeJob | Menghapus tugas distribusi perangkat. |
| ListDistributedDevice | Memeriksa perangkat yang telah didistribusikan. |
| ListDistributedProduct | Memeriksa produk yang telah didistribusikan. |
Distribusi Perangkat
| API | Deskripsi |
| CreateDeviceGroup | Membuat grup perangkat. |
| DeleteDeviceGroup | Menghapus grup perangkat. |
| UpdateDeviceGroup | Memodifikasi informasi tentang grup perangkat. |
| QueryDeviceGroupInfo | Mengambil detail dari grup perangkat. |
| QueryDeviceGroupList | Mengambil semua grup perangkat. |
| BatchAddDeviceGroupRelations | Menambahkan perangkat ke grup perangkat. |
| BatchDeleteDeviceGroupRelations | Menghapus perangkat dari grup perangkat. |
| SetDeviceGroupTags | Membuat tag untuk grup perangkat atau memperbarui tag dari grup perangkat. |
| QueryDeviceGroupTagList | Meminta tag dari grup perangkat. |
| QueryDeviceGroupByDevice | Meminta informasi tentang grup-grup yang dimiliki oleh sebuah perangkat. |
| QuerySuperDeviceGroup | Mengambil detail grup induk berdasarkan ID sub-grup. |
| QueryDeviceListByDeviceGroup | Meminta perangkat dalam grup perangkat. |
| QueryDeviceGroupByTags | Mengajukan pertanyaan tentang grup perangkat berdasarkan tag. |
Model Bahasa Spesifikasi Hal (TSL)
| API | Deskripsi |
| CreateThingModel | Menambahkan fitur atau informasi tambahan ke model TSL produk. |
| UpdateThingModel | Memodifikasi fitur atau informasi tambahan tentang model TSL untuk sebuah produk. |
| QueryThingModel | Meminta detail model TSL untuk sebuah produk. |
| CopyThingModel | Menyalin model TSL produk ke produk tujuan. |
| PublishThingModel | Menerbitkan model TSL produk. |
| DeleteThingModel | Menghapus fitur dari model TSL produk. |
| ListThingTemplates | Meminta semua kategori produk yang telah ditentukan sebelumnya di IoT Platform. |
| GetThingTemplate | Meminta informasi model TSL standar untuk suatu kategori. |
| ListThingModelVersion | Meminta versi model TSL produk. |
| GetThingModelTsl | Meminta model TSL sebuah produk. |
| ImportThingModelTsl | Mengimpor model TSL ke sebuah produk. Informasi tambahan tidak dapat diimpor. |
| QueryThingModelPublished | Meminta detail model TSL yang telah diterbitkan untuk sebuah produk. |
| GetThingModelTslPublished | Meminta informasi dasar tentang model TSL yang telah diterbitkan untuk sebuah produk. |
| QueryThingModelExtendConfig | Meminta informasi tambahan tentang model TSL untuk sebuah produk. |
| QueryThingModelExtendConfigPublished | Meminta informasi tambahan tentang model TSL yang telah diterbitkan. |
| CreateThingScript | Mengirimkan skrip penguraian data untuk sebuah produk. |
| UpdateThingScript | Memodifikasi skrip penguraian data untuk sebuah produk. |
| GetThingScript | Meminta skrip penguraian data untuk sebuah produk. |
Penggunaan Model TSL
| API | Deskripsi |
| SetDeviceProperty | Mengonfigurasi properti untuk sebuah perangkat. |
| SetDevicesProperty | Mengonfigurasi properti untuk beberapa perangkat sekaligus. |
| InvokeThingService | Memanggil layanan pada perangkat. |
| InvokeThingsService | Memanggil layanan pada beberapa perangkat sekaligus. |
| QueryDevicePropertyData | Mengambil catatan properti dari sebuah perangkat. |
| QueryDevicePropertiesData | Mengambil catatan dari beberapa properti perangkat. |
| QueryDeviceEventData | Mengambil catatan peristiwa dari sebuah perangkat. |
| QueryDeviceServiceData | Mengambil catatan layanan dari sebuah perangkat. |
| SetDeviceDesiredProperty | Menentukan beberapa nilai properti yang diinginkan untuk sebuah perangkat sekaligus. |
| QueryDeviceDesiredProperty | Memeriksa nilai properti yang diinginkan dari sebuah perangkat. |
| QueryDevicePropertyStatus | Mengambil snapshot properti dari sebuah perangkat. |
| QueryDeviceOriginalPropertyStatus | Mengambil snapshot properti asli dari sebuah perangkat. |
| QueryDeviceOriginalPropertyData | Mengambil catatan properti asli dari sebuah perangkat. |
| QueryDeviceOriginalEventData | Mengambil catatan peristiwa asli dari sebuah perangkat. |
| QueryDeviceOriginalServiceData | Meminta catatan layanan asli dari sebuah perangkat. |
| ClearDeviceDesiredProperty | Menghapus nilai yang diinginkan dari properti perangkat. |
Pengalihan Data (versi lama)
| API | Deskripsi |
| ListRule | Meminta aturan. |
| CreateRule | Membuat aturan. |
| GetRule | Meminta detail aturan. |
| UpdateRule | Memodifikasi aturan. |
| DeleteRule | Menghapus aturan. |
| ListDataSourceItem | Meminta topik dari sumber data dalam mesin aturan. |
| ListRuleActions | Meminta aksi aturan. |
| GetRuleAction | Meminta detail aksi aturan. |
| CreateRuleAction | Membuat aksi aturan. |
| UpdateRuleAction | Memodifikasi aksi aturan. |
| DeleteRuleAction | Menghapus aksi aturan. |
| StartRule | Mengaktifkan aturan. |
| StopRule | Menonaktifkan aturan. |
Pengalihan Data (versi baru)
| API | Deskripsi |
| CreateParser | Membuat parser. |
| UpdateParser | Memperbarui nama dan deskripsi parser. |
| ListParser | Meminta detail parser. Detail tersebut mencakup informasi dasar, status, waktu pembuatan, dan waktu modifikasi. |
| GetParser | Meminta detail parser. Detail tersebut mencakup informasi dasar, skrip penguraian, status, dan sumber data terkait. |
| DeleteParser | Menghapus parser. |
| CreateParserDataSource | Membuat sumber data dari mana Anda ingin mengalihkan data. |
| UpdateParserDataSource | Memperbarui nama dan deskripsi sumber data. |
| ListParserDataSource | Meminta semua sumber data. |
| GetParserDataSource | Meminta detail sumber data. |
| DeleteParserDataSource | Menghapus sumber data. |
| CreateDataSourceItem | Menambahkan topik ke sumber data. |
| ListDataSourceItem | Meminta topik dari sumber data. |
| DeleteDataSourceItem | Memisahkan topik dari sumber data. |
| CreateDestination | Membuat tujuan data untuk pengalihan data. |
| UpdateDestination | Memperbarui nama, tipe, dan deskripsi tujuan data. |
| ListDestination | Meminta tujuan data. |
| GetDestination | Meminta detail tujuan data. |
| DeleteDestination | Menghapus tujuan data. |
| AttachParserDataSource | Menghubungkan parser dengan sumber data tertentu. |
| ListParserDestination | Meminta daftar tujuan data yang terhubung dengan parser. |
| DetachParserDataSource | Memisahkan parser dari sumber data. |
| AttachDestination | Menghubungkan parser dengan tujuan data tertentu. |
| DetachDestination | Memisahkan parser dari tujuan data. |
| SaveScript | Memodifikasi dan menyimpan draf skrip parser. |
| PublishScript | Menerbitkan skrip dalam parser. |
| StartParser | Mengaktifkan parser. |
| StopParser | Menonaktifkan parser. |
Topik
| API | Deskripsi |
| CreateProductTopic | Membuat kategori topik kustom untuk sebuah produk. |
| UpdateProductTopic | Memodifikasi kategori topik kustom. |
| QueryProductTopic | Meminta kategori topik kustom dari sebuah produk. |
| DeleteProductTopic | Menghapus kategori topik kustom. |
| CreateTopicRouteTable | Membuat tabel rute untuk topik. |
| QueryTopicRouteTable | Meminta tabel rute dari topik. |
| QueryTopicReverseRouteTable | Meminta tabel rute balik dari topik. |
| DeleteTopicRouteTable | Menghapus tabel rute dari topik. |
Langganan Server-Side
| API | Deskripsi |
| CreateSubscribeRelation | Membuat langganan server-side Message Service (MNS) atau Advanced Message Queuing Protocol (AMQP). |
| UpdateSubscribeRelation | Memodifikasi langganan server-side MNS atau AMQP. |
| QuerySubscribeRelation | Meminta detail langganan server-side MNS atau AMQP. |
| DeleteSubscribeRelation | Menghapus langganan server-side MNS atau AMQP. |
| CreateConsumerGroup | Membuat grup konsumen untuk membuat langganan server-side AMQP. |
| UpdateConsumerGroup | Mengubah nama grup konsumen. |
| QueryConsumerGroupByGroupId | Meminta detail grup konsumen berdasarkan ID grup konsumen. |
| QueryConsumerGroupList | Meminta semua grup konsumen akun, atau melakukan pencarian fuzzy berdasarkan nama grup konsumen. |
| QueryConsumerGroupStatus | Meminta status grup konsumen saat langganan server-side AMQP diaktifkan. Informasi status mencakup informasi klien online, laju konsumsi pesan, jumlah pesan yang menumpuk, dan waktu konsumsi pesan terbaru. |
| ResetConsumerGroupPosition | Menghapus pesan yang menumpuk di grup konsumen saat langganan server-side AMQP diaktifkan. |
| DeleteConsumerGroup | Menghapus grup konsumen. |
| CreateConsumerGroupSubscribeRelation | Menambahkan grup konsumen ke langganan server-side AMQP. |
| DeleteConsumerGroupSubscribeRelation | Menghapus grup konsumen dari langganan server-side AMQP. |
Pesan
| API | Deskripsi |
| RRpc | Mengirim permintaan ke perangkat dan secara sinkron menerima respons dari perangkat. |
| PubBroadcast | Menyebarkan pesan ke semua perangkat dari suatu produk atau semua perangkat yang berlangganan topik tertentu. |
| Pub | Menerbitkan pesan ke perangkat menggunakan topik kustom. Anda dapat memanggil operasi ini untuk menyiarkan pesan ke perangkat online yang berlangganan topik kustom tersebut. Perangkat online tersebut termasuk dalam produk tertentu. |
| BatchPub | Menerbitkan pesan ke beberapa perangkat dari suatu produk menggunakan topik kustom. |
| SubscribeTopic | Berlangganan topik untuk perangkat. |
| QueryDeviceSubTopic | Memeriksa topik-topik yang disubskripsikan oleh perangkat. |
Bayangan Perangkat
| API | Description |
| GetDeviceShadow | Mengambil informasi bayangan tentang perangkat. |
| UpdateDeviceShadow | Memodifikasi informasi bayangan tentang perangkat. |
Pembaruan OTA
| API | Deskripsi |
| GenerateOTAUploadURL | Menghasilkan URL dan detail paket pembaruan yang akan diunggah ke OSS. |
| GenerateDeviceNameListURL | Menghasilkan URL dan detail file daftar perangkat yang akan diunggah ke OSS. Saat Anda membuat batch pembaruan statis, Anda dapat menentukan perangkat yang akan diperbarui dalam file daftar perangkat. |
| CreateOTAFirmware | Menambahkan paket pembaruan. |
| DeleteOTAFirmware | Menghapus paket pembaruan. |
| ListOTAFirmware | Meminta daftar paket pembaruan. |
| QueryOTAFirmware | Meminta detail paket pembaruan. |
| CreateOTAVerifyJob | Membuat batch verifikasi untuk paket pembaruan. |
| CreateOTAStaticUpgradeJob | Membuat batch pembaruan statis. |
| CreateOTADynamicUpgradeJob | Membuat batch pembaruan dinamis. |
| ListOTAJobByFirmware | Meminta batch pembaruan dari paket pembaruan. |
| ListOTAJobByDevice | Meminta batch pembaruan dari paket pembaruan berdasarkan perangkat. |
| ListOTATaskByJob | Meminta tugas pembaruan perangkat berdasarkan batch pembaruan. |
| QueryOTAJob | Meminta detail batch pembaruan. |
| CancelOTAStrategyByJob | Membatalkan kebijakan pembaruan yang terkait dengan batch pembaruan dinamis. |
| CancelOTATaskByDevice | Membatalkan tugas pembaruan perangkat tertunda dari paket pembaruan. |
| CancelOTATaskByJob | Membatalkan tugas pembaruan perangkat dari batch pembaruan. |
| CreateOTAModule | Membuat modul OTA untuk produk. |
| UpdateOTAModule | Memodifikasi alias dan deskripsi modul OTA. |
| DeleteOTAModule | Menghapus modul OTA kustom. |
| ListOTAModuleByProduct | Meminta modul OTA dari produk. |
| ConfirmOTATask | Mengonfirmasi tugas pembaruan perangkat yang berstatus menunggu konfirmasi. |
| ListOTAUnfinishedTaskByDevice | Meminta tugas pembaruan perangkat yang belum selesai dari perangkat. |