Aşağıdaki tablolar, IoT Platform'da kullanılabilecek API işlemlerini açıklamaktadır.
Ürünler
| API | Açıklama |
| CreateProduct | Bir ürün oluşturur. |
| UpdateProduct | Bir ürün hakkındaki bilgileri değiştirir. |
| QueryProductList | Ürünleri sorgular. |
| QueryProduct | Bir ürünün ayrıntılarını sorgular. |
| DeleteProduct | Bir ürünü siler. |
| CreateProductTags | Ürün etiketleri oluşturur. |
| UpdateProductTags | Bir ürünün etiketlerini değiştirir. |
| DeleteProductTags | Ürün etiketlerini siler. |
| ListProductTags | Bir ürünün tüm etiketlerini sorgular. |
| ListProductByTags | Etikete göre ürünleri sorgular. |
| UpdateProductFilterConfig | Bir ürünün cihazları tarafından gönderilen özellik mesajları için yinelenen veri engelleme kuralını değiştirir. |
| ReleaseProduct | Bir ürünü yayımlar. |
| CancelReleaseProduct | Bir ürünün yayımlanmasını geri alır. |
Cihazlar
| API | Açıklama |
| RegisterDevice | Bir cihazı kaydeder. |
| QueryClientIds | Bir cihazın ClientID'lerini sorgular. Bu API işlemi, ön kayıt gerektirmeyen ürün başına tek sertifika doğrulaması için desteklenir. |
| TransformClientId | Cihazda birden fazla ClientID varsa yetkisiz oturum açmaları önlemek için geçerli bir ClientID belirtir. Bu API işlemi, ön kayıt gerektirmeyen ürün başına tek sertifika doğrulaması için desteklenir. |
| DeleteClientIds | ClientID sayısı sınırı (5) aşarsa bir cihazın tüm ClientID'lerini siler. Bu API işlemi, ön kayıt gerektirmeyen ürün başına tek sertifika doğrulaması için desteklenir. |
| QueryDeviceInfo | Bir cihaz hakkında temel bilgileri sorgular. Bilgiler arasında cihaz kimliği, cihaz sertifikası ve takma ad bulunur. |
| QueryDeviceDetail | Bir cihazın ayrıntılarını sorgular. |
| BatchQueryDeviceDetail | Birden çok cihazın ayrıntılarını sorgular. |
| QueryDevice | Bir ürünün cihazlarını sorgular. |
| DeleteDevice | Bir cihazı siler. |
| GetDeviceStatus | Bir cihazın durumunu sorgular. |
| BatchGetDeviceState | Cihazların durumlarını sorgular. |
| DisableThing | Bir cihazı devre dışı bırakır. |
| EnableThing | Devre dışı bırakılmış bir cihazı etkinleştirir. |
| ResetThing | Bir cihazı sıfırlar. |
| BatchCheckDeviceNames | Aynı anda birden çok cihaz için ad belirtir. IoT Platform, adların geçerli olup olmadığını kontrol eder. |
| BatchRegisterDeviceWithApplyId | Bir uygulama kimliği kullanarak aynı anda birden çok cihazı kaydeder. |
| BatchRegisterDevice | Aynı anda birden çok cihazı kaydeder. |
| QueryBatchRegisterDeviceStatus | Birden çok cihazın kaydı için işlem durumunu sorgular. |
| QueryPageByApplyId | Uygulama kimliğine göre birden çok cihazı sorgular. |
| SaveDeviceProp | Bir cihaz için etiketler oluşturur. |
| QueryDeviceProp | Bir cihazın etiketlerini sorgular. |
| DeleteDeviceProp | Bir cihazın etiketlerini siler. |
| GetThingTopo | Bir ağ geçidi cihazının alt cihazlarını sorgular. |
| NotifyAddThingTopo | Bir ağ geçidi cihazını alt cihazla topolojik ilişki kurması konusunda bilgilendirir. |
| BatchAddThingTopo | Birden çok alt cihaz ile bir ağ geçidi cihazı arasında topolojik ilişkiler kurar. |
| RemoveThingTopo | Bir cihazın topolojik ilişkilerini kaldırır. |
| QueryDeviceStatistics | Cihaz istatistiklerini sorgular. |
| GetGatewayBySubDevice | Alt cihaz bilgilerine göre bir ağ geçidi cihazı hakkında bilgi sorgular. |
| QueryDeviceByTags | Etikete göre cihazları sorgular. |
| QueryDeviceFileList | Bir cihazdan IoT Platform'a yüklenen dosyaları sorgular. |
| QueryDeviceFile | Bir cihazdan IoT Platform'a yüklenen bir dosyanın ayrıntılarını sorgular. |
| DeleteDeviceFile | Bir cihazdan IoT Platform'a yüklenen bir dosyayı siler. |
| BatchUpdateDeviceNickname | Birden çok cihazın takma adlarını değiştirir. |
| QueryDeviceByStatus | Duruma göre cihazları sorgular. |
| ListOTAModuleVersionsByDevice | Cihazlar tarafından gönderilen kablosuz (OTA) modül sürümlerini sorgular. |
| ImportDevice | Bir MQTT ağ geçidi ürününe bir cihaz ekler. |
| BatchImportDevice | Aynı anda birden çok cihazı bir MQTT ağ geçidi ürününe ekler. |
| BatchCheckImportDevice | Aynı anda bir MQTT ağ geçidi ürününe eklenen birden çok cihazı doğrular. |
| QueryImportedDeviceByApplyId | Uygulama kimliğine göre aynı anda eklenen birden çok cihazı sorgular. |
| BatchImportVehicleDevice | Aynı anda birden çok cihazı bir JT/T 808 ağ geçidi ürününe ekler. |
| BatchCheckVehicleDevice | Aynı anda bir JT/T 808 ağ geçidi ürününe eklenen birden çok cihazı doğrular. |
| QueryVehicleDevice | Bir JT/T 808 ağ geçidi ürünündeki bir cihaz hakkında bilgi sorgular. |
Cihaz dağıtımı
| API | Açıklama |
| CreateDeviceDistributeJob | Cihazları dağıtmak için bir görev oluşturur. Cihazların ait olduğu ürün de dağıtılır. |
| CreateProductDistributeJob | Bir ürünü bir örneğe dağıtmak için görev oluşturur. |
| QueryDeviceDistributeDetail | Bir cihaz dağıtım görevinin sonucunu sorgular. |
| QueryDeviceDistributeJob | Bir cihaz dağıtım görevinin ayrıntılarını sorgular. |
| ListDeviceDistributeJob | Cihaz dağıtım görevlerini sorgular. |
| DeleteDeviceDistributeJob | Bir cihaz dağıtım görevini siler. |
| ListDistributedDevice | Dağıtılan cihazları sorgular. |
| ListDistributedProduct | Dağıtılan ürünleri sorgular. |
Cihaz grupları
| API | Açıklama |
| CreateDeviceGroup | Bir cihaz grubu oluşturur. |
| DeleteDeviceGroup | Bir cihaz grubunu siler. |
| UpdateDeviceGroup | Bir cihaz grubu hakkındaki bilgileri değiştirir. |
| QueryDeviceGroupInfo | Bir cihaz grubunun ayrıntılarını sorgular. |
| QueryDeviceGroupList | Tüm cihaz gruplarını sorgular. |
| BatchAddDeviceGroupRelations | Cihazları bir cihaz grubuna ekler. |
| BatchDeleteDeviceGroupRelations | Cihazları bir cihaz grubundan kaldırır. |
| SetDeviceGroupTags | Bir cihaz grubu için etiketler oluşturur veya bir cihaz grubunun etiketlerini günceller. |
| QueryDeviceGroupTagList | Bir cihaz grubunun etiketlerini sorgular. |
| QueryDeviceGroupByDevice | Bir cihazın ait olduğu grupları sorgular. |
| QuerySuperDeviceGroup | Alt grup kimliğine göre bir üst grubun ayrıntılarını sorgular. |
| QueryDeviceListByDeviceGroup | Bir cihaz grubundaki cihazları sorgular. |
| QueryDeviceGroupByTags | Etikete göre cihaz gruplarını sorgular. |
Thing Specification Language (TSL) modelleri
| API | Açıklama |
| CreateThingModel | Bir ürünün TSL modeline özellikler veya genişletilmiş bilgiler ekler. |
| UpdateThingModel | Bir ürünün TSL modeli için bir özelliği veya genişletilmiş bilgileri değiştirir. |
| QueryThingModel | Bir ürünün TSL modelinin ayrıntılarını sorgular. |
| CopyThingModel | Bir ürünün TSL modelini hedef ürüne kopyalar. |
| PublishThingModel | Bir ürünün TSL modelini yayınlar. |
| DeleteThingModel | Bir ürünün TSL modelinden bir özelliği kaldırır. |
| ListThingTemplates | IoT Platform'da önceden tanımlanmış tüm ürün kategorilerini sorgular. |
| GetThingTemplate | Bir kategoriye ilişkin standart TSL modeli bilgilerini sorgular. |
| ListThingModelVersion | Bir ürünün TSL modeli sürümlerini sorgular. |
| GetThingModelTsl | Bir ürünün TSL modelini sorgular. |
| ImportThingModelTsl | Bir ürüne TSL modeli içeri aktarır. Genişletilmiş bilgiler içeri aktarılamaz. |
| QueryThingModelPublished | Bir ürünün yayınlanmış TSL modelinin ayrıntılarını sorgular. |
| GetThingModelTslPublished | Bir ürünün yayınlanmış TSL modeliyle ilgili temel bilgileri sorgular. |
| QueryThingModelExtendConfig | Bir ürünün TSL modeliyle ilgili genişletilmiş bilgileri sorgular. |
| QueryThingModelExtendConfigPublished | Yayınlanmış bir TSL modeliyle ilgili genişletilmiş bilgileri sorgular. |
| CreateThingScript | Bir ürün için veri ayrıştırma betiği gönderir. |
| UpdateThingScript | Bir ürün için veri ayrıştırma betiğini değiştirir. |
| GetThingScript | Bir ürün için veri ayrıştırma betiğini sorgular. |
TSL modellerinin kullanımı
| API | Açıklama |
| SetDeviceProperty | Bir cihaz için özellikleri yapılandırır. |
| SetDevicesProperty | Birden çok cihaz için özellikleri aynı anda yapılandırır. |
| InvokeThingService | Bir cihazdaki hizmeti çağırır. |
| InvokeThingsService | Birden çok cihazdaki hizmeti aynı anda çağırır. |
| QueryDevicePropertyData | Bir cihazın özellik kayıtlarını sorgular. |
| QueryDevicePropertiesData | Bir cihazın birden çok özelliğine ait kayıtları sorgular. |
| QueryDeviceEventData | Bir cihazın olay kayıtlarını sorgular. |
| QueryDeviceServiceData | Bir cihazın hizmet kayıtlarını sorgular. |
| SetDeviceDesiredProperty | Bir cihaz için birden çok istenen özellik değerini aynı anda belirtir. |
| QueryDeviceDesiredProperty | Bir cihazın istenen özellik değerlerini sorgular. |
| QueryDevicePropertyStatus | Bir cihazın özellik anlık görüntülerini sorgular. |
| QueryDeviceOriginalPropertyStatus | Bir cihazın orijinal özellik anlık görüntülerini sorgular. |
| QueryDeviceOriginalPropertyData | Bir cihazın orijinal özellik kayıtlarını sorgular. |
| QueryDeviceOriginalEventData | Bir cihazın orijinal olay kayıtlarını sorgular. |
| QueryDeviceOriginalServiceData | Bir cihazın orijinal hizmet kayıtlarını sorgular. |
| ClearDeviceDesiredProperty | Bir cihazın özelliklerine ait istenen değerleri siler. |
Veri yönlendirme (eski sürüm)
| API | Açıklama |
| ListRule | Kuralları sorgular. |
| CreateRule | Kural oluşturur. |
| GetRule | Bir kuralın ayrıntılarını sorgular. |
| UpdateRule | Kuralı değiştirir. |
| DeleteRule | Kuralı siler. |
| ListDataSourceItem | Kural motorundaki bir veri kaynağının topic'lerini sorgular. |
| ListRuleActions | Kural eylemlerini sorgular. |
| GetRuleAction | Bir kural eyleminin ayrıntılarını sorgular. |
| CreateRuleAction | Kural eylemi oluşturur. |
| UpdateRuleAction | Kural eylemini değiştirir. |
| DeleteRuleAction | Kural eylemini siler. |
| StartRule | Kuralı etkinleştirir. |
| StopRule | Kuralı devre dışı bırakır. |
Veri yönlendirme (yeni sürüm)
| API | Açıklama |
| CreateParser | Ayrıştırıcı oluşturur. |
| UpdateParser | Ayrıştırıcının adını ve açıklamasını günceller. |
| ListParser | Ayrıştırıcıların ayrıntılarını sorgular. Ayrıntılar arasında temel bilgiler, durum, oluşturma zamanı ve değiştirme zamanı bulunur. |
| GetParser | Ayrıştırıcının ayrıntılarını sorgular. Ayrıntılar arasında temel bilgiler, ayrıştırma betiği, durum ve ilişkili veri kaynağı bulunur. |
| DeleteParser | Ayrıştırıcıyı siler. |
| CreateParserDataSource | Veri yönlendirmek istediğiniz bir veri kaynağı oluşturur. |
| UpdateParserDataSource | Veri kaynağının adını ve açıklamasını günceller. |
| ListParserDataSource | Tüm veri kaynaklarını sorgular. |
| GetParserDataSource | Veri kaynağının ayrıntılarını sorgular. |
| DeleteParserDataSource | Veri kaynağını siler. |
| CreateDataSourceItem | Veri kaynağına bir topic ekler. |
| ListDataSourceItem | Veri kaynağının topic'lerini sorgular. |
| DeleteDataSourceItem | Veri kaynağından bir topic'in ilişkisini kaldırır. |
| CreateDestination | Veri yönlendirmek istediğiniz bir veri hedefi oluşturur. |
| UpdateDestination | Veri hedefinin adını, türünü ve açıklamasını günceller. |
| ListDestination | Veri hedeflerini sorgular. |
| GetDestination | Veri hedefinin ayrıntılarını sorgular. |
| DeleteDestination | Veri hedefini siler. |
| AttachParserDataSource | Ayrıştırıcıyı bir veri kaynağıyla ilişkilendirir. |
| ListParserDestination | Ayrıştırıcıyla ilişkili veri hedeflerini sorgular. |
| DetachParserDataSource | Ayrıştırıcının veri kaynağıyla olan ilişkisini kaldırır. |
| AttachDestination | Ayrıştırıcıyı bir veri hedefiyle ilişkilendirir. |
| DetachDestination | Ayrıştırıcının veri hedefiyle olan ilişkisini kaldırır. |
| SaveScript | Ayrıştırıcı betiğinin taslağını değiştirir ve kaydeder. |
| PublishScript | Ayrıştırıcının betiğini yayınlar. |
| StartParser | Ayrıştırıcıyı etkinleştirir. |
| StopParser | Ayrıştırıcıyı devre dışı bırakır. |
Konular
| API | Açıklama |
| CreateProductTopic | Ürün için özel bir topic kategorisi oluşturur. |
| UpdateProductTopic | Özel bir topic kategorisini değiştirir. |
| QueryProductTopic | Bir ürünün özel topic kategorilerini sorgular. |
| DeleteProductTopic | Özel bir topic kategorisini siler. |
| CreateTopicRouteTable | Bir topic için yönlendirme tablosu oluşturur. |
| QueryTopicRouteTable | Bir topic'in yönlendirme tablosunu sorgular. |
| QueryTopicReverseRouteTable | Bir topic'in ters yönlendirme tablosunu sorgular. |
| DeleteTopicRouteTable | Bir topic'in yönlendirme tablosunu siler. |
Sunucu tarafı abonelik
| API | Açıklama |
| CreateSubscribeRelation | Message Service (MNS) sunucu tarafı aboneliği veya Advanced Message Queuing Protocol (AMQP) sunucu tarafı aboneliği oluşturur. |
| UpdateSubscribeRelation | MNS sunucu tarafı aboneliğini veya AMQP sunucu tarafı aboneliğini değiştirir. |
| QuerySubscribeRelation | MNS sunucu tarafı aboneliğinin veya AMQP sunucu tarafı aboneliğinin ayrıntılarını sorgular. |
| DeleteSubscribeRelation | MNS sunucu tarafı aboneliğini veya AMQP sunucu tarafı aboneliğini siler. |
| CreateConsumerGroup | AMQP sunucu tarafı aboneliği oluşturmak için bir tüketici grubu oluşturur. |
| UpdateConsumerGroup | Bir tüketici grubunun adını değiştirir. |
| QueryConsumerGroupByGroupId | Tüketici grubu kimliğine göre bir tüketici grubunun ayrıntılarını sorgular. |
| QueryConsumerGroupList | Bir hesabın tüm tüketici gruplarını sorgular veya tüketici grubu adına göre bulanık arama yapar. |
| QueryConsumerGroupStatus | AMQP sunucu tarafı aboneliği etkinleştirildiğinde bir tüketici grubunun durumunu sorgular. Durum bilgileri; çevrimiçi istemci bilgilerini, mesaj tüketim hızını, birikmiş mesaj sayısını ve en son mesaj tüketim zamanını içerir. |
| ResetConsumerGroupPosition | AMQP sunucu tarafı aboneliği etkinleştirildiğinde bir tüketici grubunun birikmiş mesajlarını temizler. |
| DeleteConsumerGroup | Bir tüketici grubunu siler. |
| CreateConsumerGroupSubscribeRelation | AMQP sunucu tarafı aboneliğine bir tüketici grubu ekler. |
| DeleteConsumerGroupSubscribeRelation | AMQP sunucu tarafı aboneliğinden bir tüketici grubunu kaldırır. |
Mesajlaşma
| API | Açıklama |
| RRpc | Bir cihaza istek gönderir ve cihazdan eşzamanlı olarak yanıt alır. |
| PubBroadcast | Bir ürünün tüm cihazlarına veya bir topic'e abone olan tüm cihazlara mesaj yayınlar. |
| Pub | Özel bir topic kullanarak bir cihaza mesaj yayınlar. Bu işlemi, belirtilen bir ürüne ait olan ve özel topic'e abone olan çevrimiçi cihazlara mesaj yayınlamak için çağırabilirsiniz. |
| BatchPub | Özel bir topic kullanarak bir ürünün birden fazla cihazına mesaj yayınlar. |
| SubscribeTopic | Bir cihaz için bir topic'e abonelik oluşturur. |
| QueryDeviceSubTopic | Bir cihazın abone olduğu topic'leri sorgular. |
Cihaz gölgeleri
| API | Açıklama |
| GetDeviceShadow | Bir cihazın gölge bilgilerini sorgular. |
| UpdateDeviceShadow | Bir cihazın gölge bilgilerini değiştirir. |
OTA güncellemeleri
| API | Açıklama |
| GenerateOTAUploadURL | OSS'e yüklenecek bir yükseltme paketinin URL'sini ve ayrıntılarını oluşturur. |
| GenerateDeviceNameListURL | OSS'e yüklenecek bir cihaz listesi dosyasının URL'sini ve ayrıntılarını oluşturur. Statik bir yükseltme partisi oluştururken, yükseltilecek cihazları bir cihaz listesi dosyasında belirtebilirsiniz. |
| CreateOTAFirmware | Bir yükseltme paketi ekler. |
| DeleteOTAFirmware | Bir yükseltme paketini kaldırır. |
| ListOTAFirmware | Yükseltme paketlerini sorgular. |
| QueryOTAFirmware | Bir yükseltme paketinin ayrıntılarını sorgular. |
| CreateOTAVerifyJob | Bir yükseltme paketi için doğrulama partisi oluşturur. |
| CreateOTAStaticUpgradeJob | Statik bir yükseltme partisi oluşturur. |
| CreateOTADynamicUpgradeJob | Dinamik bir yükseltme partisi oluşturur. |
| ListOTAJobByFirmware | Bir yükseltme paketinin yükseltme partilerini sorgular. |
| ListOTAJobByDevice | Cihaza göre bir yükseltme paketinin yükseltme partilerini sorgular. |
| ListOTATaskByJob | Yükseltme partisine göre bir cihazın yükseltme görevlerini sorgular. |
| QueryOTAJob | Bir yükseltme partisinin ayrıntılarını sorgular. |
| CancelOTAStrategyByJob | Dinamik bir yükseltme partisiyle ilişkili bir yükseltme politikasını iptal eder. |
| CancelOTATaskByDevice | Bir yükseltme paketinin bekleyen cihaz yükseltme görevlerini iptal eder. |
| CancelOTATaskByJob | Bir yükseltme partisinin cihaz yükseltme görevlerini iptal eder. |
| CreateOTAModule | Bir ürün için bir OTA modülü oluşturur. |
| UpdateOTAModule | Bir OTA modülünün takma adını ve açıklamasını değiştirir. |
| DeleteOTAModule | Özel bir OTA modülünü kaldırır. |
| ListOTAModuleByProduct | Bir ürünün OTA modüllerini sorgular. |
| ConfirmOTATask | Beklemede onay durumunda olan cihaz yükseltme görevlerini onaylar. |
| ListOTAUnfinishedTaskByDevice | Bir cihazın tamamlanmamış cihaz yükseltme görevlerini sorgular. |