The following tables list the API operations available for use in IoT Platform.
Products
| Operation | Description |
|---|---|
| CreateProduct | Creates a product. |
| UpdateProduct | Modifies the information of a product. |
| QueryProductList | Queries products. |
| QueryProduct | Queries the details of a product. |
| DeleteProduct | Deletes a product. |
| CreateProductTags | Creates tags for a product. |
| UpdateProductTags | Updates the tags of a product. |
| DeleteProductTags | Deletes the tags of a product. |
| ListProductTags | Queries all the tags of a product. |
| ListProductByTags | Queries products by tag. |
| UpdateProductFilterConfig | Modifies the deduplication rule for properties that are reported by the devices of a product. |
Devices
| Operation | Description |
|---|---|
| RegisterDevice | Registers a device. |
| QueryDeviceDetail | Queries the details of a device. |
| BatchQueryDeviceDetail | Queries the details of multiple devices. |
| QueryDevice | Queries the devices of a product. |
| DeleteDevice | Deletes a device. |
| GetDeviceStatus | Queries the status of a device. |
| BatchGetDeviceState | Queries the status of multiple devices. |
| DisableThing | Disables a device. |
| EnableThing | Enables a device that has been disabled. |
| ResetThing | Resets a device. |
| BatchCheckDeviceNames | Specifies names for devices. IoT Platform checks whether these names are valid. |
| BatchRegisterDeviceWithApplyId | Registers multiple devices by application ID. |
| BatchRegisterDevice | Registers multiple devices. |
| QueryBatchRegisterDeviceStatus | Queries the processing status of registration for multiple devices. |
| QueryPageByApplyId | Queries multiple devices by application ID. |
| SaveDeviceProp | Creates tags for a device. |
| QueryDeviceProp | Queries the tags of a device. |
| DeleteDeviceProp | Deletes the tags of a device. |
| GetThingTopo | Queries the sub-devices of a gateway device. |
| NotifyAddThingTopo | Notifies a gateway device to build a topological relationship with a sub-device. |
| BatchAddThingTopo | Builds topological relationships between multiple sub-devices and a gateway device. |
| RemoveThingTopo | Removes the topological relationships of a device. |
| QueryDeviceStatistics | Queries device statistics. |
| GetGatewayBySubDevice | Queries the information of a gateway device based on sub-device information. |
| QueryDeviceByTags | Queries devices by tag. |
| QueryDeviceFileList | Queries the information of all files that are uploaded to IoT Platform from a device. |
| QueryDeviceFile | Queries the information of a file that is uploaded to IoT Platform from a device. |
| DeleteDeviceFile | Deletes a file that is uploaded to IoT Platform from a device. |
| BatchUpdateDeviceNickname | Modifies the aliases of multiple devices. |
| QueryDeviceByStatus | Queries devices by status. |
| ListOTAModuleVersionsByDevice | Queries the version information of the Over-the-Air (OTA) modules that are reported by a device. |
Device distribution
| Operation | Description |
|---|---|
| CreateDeviceDistributeJob | Creates a task to distribute devices. By default, the product to which the devices belong is distributed. |
| CreateProductDistributeJob | Creates a task to distribute a product to a specified instance. |
| QueryDeviceDistributeDetail | Queries the result of a device distribution task. |
| QueryDeviceDistributeJob | Queries the details of a device distribution task. |
| ListDeviceDistributeJob | Queries device distribution tasks. |
| DeleteDeviceDistributeJob | Deletes a device distribution task. |
| ListDistributedDevice | Queries distributed devices. |
| ListDistributedProduct | Queries distributed products. |
Device groups
| Operation | Description |
|---|---|
| CreateDeviceGroup | Creates a device group. |
| DeleteDeviceGroup | Deletes a device group. |
| UpdateDeviceGroup | Modifies the information of a device group. |
| QueryDeviceGroupInfo | Queries the details of a device group. |
| QueryDeviceGroupList | Queries all device groups. |
| BatchAddDeviceGroupRelations | Adds devices to a device group. |
| BatchDeleteDeviceGroupRelations | Removes a device from a device group. |
| SetDeviceGroupTags | Creates tags for or modifies the tags of a device group. |
| QueryDeviceGroupTagList | Queries the tags of a device group. |
| QueryDeviceGroupByDevice | Queries the information of the device group to which a specified device belongs. |
| QuerySuperDeviceGroup | Queries the information of a parent group by sub-group ID. |
| QueryDeviceListByDeviceGroup | Queries all devices in a device group. |
| QueryDeviceGroupByTags | Queries the information of device groups by tag. |
Thing Specification Language (TSL) models
| Operation | Description |
|---|---|
| CreateThingModel | Adds features or extended information to the TSL model of a product. |
| UpdateThingModel | Modifies a specified feature or extended information of the TSL model for a product. |
| QueryThingModel | Queries the feature details of the TSL model for a product. |
| CopyThingModel | Copies the TSL model of a product to that of a destination product. |
| PublishThingModel | Publishes the TSL model of a product. |
| DeleteThingModel | Removes a feature from the TSL model of a product. |
| ListThingTemplates | Queries all product categories that are predefined in IoT Platform. |
| GetThingTemplate | Queries the standard TSL model information of a category. |
| ListThingModelVersion | Queries the TSL model versions of a product. |
| GetThingModelTsl | Queries the TSL model of a product. |
| ImportThingModelTsl | Imports a TSL model for a product. Extended information cannot be imported. |
| QueryThingModelPublished | Queries the feature details of the TSL model of a published version for a product. |
| GetThingModelTslPublished | Queries the information of the TSL model of a published version for a product. |
| QueryThingModelExtendConfig | Queries the extended information of the TSL model for a product. |
| QueryThingModelExtendConfigPublished | Queries the extended information of a published TSL model. |
| CreateThingScript | Submits a data parsing script for a specified product. |
| UpdateThingScript | Modifies a data parsing script for a specified product. |
| GetThingScript | Queries a data parsing script for a specified product. |
Use of TSL models
| Operation | Description |
|---|---|
| SetDeviceProperty | Sets properties for a device. |
| SetDevicesProperty | Sets properties for multiple devices. |
| InvokeThingService | Invokes a service on a device. |
| InvokeThingsService | Invokes a service on multiple devices. |
| QueryDevicePropertyData | Queries the property records of a device. |
| QueryDevicePropertiesData | Queries the statistics of multiple properties of a device. |
| QueryDeviceEventData | Queries the event records of a device. |
| QueryDeviceServiceData | Queries the service records of a device. |
| SetDeviceDesiredProperty | Sets desired property values for a device. |
| QueryDeviceDesiredProperty | Queries the desired property values of a device. |
| QueryDevicePropertyStatus | Queries the property snapshots of a device. |
| QueryDeviceOriginalPropertyStatus | Queries the original property snapshots of a device. |
| QueryDeviceOriginalPropertyData | Queries the original property records of a device. |
| QueryDeviceOriginalEventData | Queries the original event records of a device. |
| QueryDeviceOriginalServiceData | Queries the original service records of a device. |
Data forwarding
| Operation | Description |
|---|---|
| ListRule | Queries all rules. |
| CreateRule | Creates a rule. |
| GetRule | Queries the details of a rule. |
| UpdateRule | Modifies a rule. |
| DeleteRule | Deletes a rule. |
| ListRuleActions | Queries rule actions. |
| GetRuleAction | Queries the details of a rule action. |
| CreateRuleAction | Creates a rule action. |
| UpdateRuleAction | Modifies a rule action. |
| DeleteRuleAction | Deletes a rule action. |
| StartRule | Enables a rule. |
| StopRule | Disables a rule. |
Topics
| Operation | Description |
|---|---|
| CreateProductTopic | Creates a topic category for a product. |
| UpdateProductTopic | Modifies a topic category. |
| QueryProductTopic | Queries the topic categories of a product. |
| DeleteProductTopic | Deletes a topic category. |
| CreateTopicRouteTable | Creates message routing relationships between topics. |
| QueryTopicRouteTable | Queries the destination topics that subscribe to a source topic. |
| QueryTopicReverseRouteTable | Queries the source topics to which a destination topic subscribes. |
| DeleteTopicRouteTable | Deletes message routing relationships between topics. |
Server-side subscriptions
| Operation | Description |
|---|---|
| CreateSubscribeRelation | Creates a Message Service (MNS) or an AMQP server-side subscription. |
| UpdateSubscribeRelation | Modifies an MNS or AMQP server-side subscription. |
| QuerySubscribeRelation | Queries an MNS or AMQP server-side subscription. |
| DeleteSubscribeRelation | Deletes an MNS or AMQP server-side subscription. |
| CreateConsumerGroup | Creates a consumer group that is required for an AMQP server-side subscription. |
| UpdateConsumerGroup | Modifies the name of a consumer group. |
| QueryConsumerGroupByGroupId | Queries the details of a consumer group by consumer group ID. |
| QueryConsumerGroupList | Queries all the consumer groups of an account, or performs a fuzzy search by consumer group name. |
| QueryConsumerGroupStatus | Queries the status of a consumer group when an AMQP server-side subscription is enabled. The status information includes the online client information, message consumption rate, number of accumulated messages, and latest message consumption time. |
| ResetConsumerGroupPosition | Clears the accumulated messages of a consumer group when an AMQP server-side subscription is enabled. |
| DeleteConsumerGroup | Deletes a consumer group. |
| CreateConsumerGroupSubscribeRelation | Adds a consumer group to an AMQP subscription. |
| DeleteConsumerGroupSubscribeRelation | Removes a consumer group from an AMQP subscription. |
Messaging
| Operation | Description |
|---|---|
| RRpc | Sends a request to a specified device and synchronously receives a response from the device. |
| PubBroadcast | Broadcasts a message to all devices of a specified product or all devices that subscribe to a specified topic. |
| Pub | Publishes a message to a specified device by using a custom topic. |
| BatchPub | Publishes a message to multiple devices of a product by using a custom topic.
Note This operation can be used only by users in the whitelist. If you need to use this operation, submit a ticket.
|
Device shadows
| Operation | Description |
|---|---|
| GetDeviceShadow | Queries the shadow information of a device. |
| UpdateDeviceShadow | Modifies the shadow information of a device. |
OTA updates
| Operation | Description |
|---|---|
| GenerateOTAUploadURL | Generates the URL and details of an update package to be uploaded to OSS. |
| GenerateDeviceNameListURL | Generates the URL and details of a device list file to be uploaded to OSS. When you create a static update batch, you can specify devices to be updated in a device list file. |
| CreateOTAFirmware | Creates an update package. |
| DeleteOTAFirmware | Deletes an update package. |
| ListOTAFirmware | Queries update packages. |
| QueryOTAFirmware | Queries the details of an update package. |
| CreateOTAVerifyJob | Creates a verification task for an update package. |
| CreateOTAStaticUpgradeJob | Creates a static update batch. |
| CreateOTADynamicUpgradeJob | Creates a dynamic update batch. |
| ListOTAJobByFirmware | Queries the update batches of an update package. |
| ListOTAJobByDevice | Queries the update batches of an update package by device. |
| ListOTATaskByJob | Queries the update tasks of a device by update batch. |
| QueryOTAJob | Queries the details of an update batch. |
| CancelOTAStrategyByJob | Cancels an update policy that is associated with a dynamic update batch. |
| CancelOTATaskByDevice | Cancels the pending device update tasks of an update package. |
| CancelOTATaskByJob | Cancels the device update tasks of an update batch. |
| CreateOTAModule | Creates an OTA module for a product. |
| UpdateOTAModule | Modifies the alias and description of an OTA module. |
| DeleteOTAModule | Deletes a custom OTA module. |
| ListOTAModuleByProduct | Queries the OTA modules of a product. |