The following tables describe the API operations that are available for IoT Platform.
API operations for products
| API | 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. |
API operations for devices
| API | Description |
|---|---|
| RegisterDevice | Creats 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 statuses of devices. |
| DisableThing | Disables a device. |
| EnableThing | Enables a device. |
| ResetThing | Resets a device. |
| BatchCheckDeviceNames | Specifies custom device names. IoT Platform checks whether these device names are valid. |
| BatchRegisterDeviceWithApplyId | Creates multiple devices by application ID. |
| BatchRegisterDevice | Creates multiple devices. |
| QueryBatchRegisterDeviceStatus | Queries the statuses of 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 topological relationship of a gateway or sub-device. |
| NotifyAddThingTopo | Notifies a gateway to build a topological relationship with devices. |
| BatchAddTingTopo | Builds a topological relationship with multiple devices. |
| RemoveThingTopo | Removes the topological relationships of a device. |
| QueryDeviceStatistics | Queries device statistics. |
| GetGatewayBySubDevice | Queries the information of a gateway 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. |
API operations for device groups
| API | 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. |
API operations for Thing Specification Language (TSL) models
| API | Description |
|---|---|
| CreateThingModel | Adds the features of a product or extended information to a TSL model. |
| UpdateThingModel | Modifies the feature of a product or extended information for a TSL model. |
| QueryThingModel | Queries the feature details of a TSL model for a product. |
| CopyThingModel | Copies the TSL model of a product to a destination product. |
| PublishThingModel | Publishes the TSL model of a product. |
| DeleteThingModel | Removes a feature from a TSL model for a product. |
| ListThingTemplates | Queries all product categories that are predefined in IoT Platform. |
| GetThingTemplate | Queries the standard TSL information of a category. |
| ListThingModelVersion | Queries the TSL versions of a product. |
| GetThingModelTsl | Queries the TSL model of a product. |
| ImportThingModelTsl | Imports a TSL model for a product. Extended TSL information cannot be imported. |
| QueryThingModelPublished | Queries the feature details of a published TSL model for a product. |
| GetThingModelTslPublished | Queries the information of a published TSL model for a product. |
| QueryThingModelExtendConfig | Queries the extended information of a TSL model for a product. |
API operations for TSL usage
| API | 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 expected property values for a device. |
| QueryDeviceDesiredProperty | Queries the expected property values of a device. |
| QueryDevicePropertyStatus | Queries the property snapshots of a device. |
API operations for data forwarding
| API | Description |
|---|---|
| ListRule | Queries 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. |
API operations for topics
| API | Description |
|---|---|
| QueryProductTopic | Queries the topic categories of a product. |
| CreateProductTopic | Creates a topic category for a product. |
| UpdateProductTopic | Modifies a topic category. |
| 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. |
API operations for server-side subscriptions
| API | Description |
|---|---|
| CreateSubscribeRelation | Creates a Message Service (MNS) or 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 multiple consumer groups of an AMQP subscription. |
API operations for messaging
| API | Description |
|---|---|
| Pub | Publishes messages to a topic. |
| RRpc | Sends a request to a device and receives a response from the device at the same time. |
| PubBroadcast | Broadcasts a message. |
API operations for device shadows
| API | Description |
|---|---|
| GetDeviceShadow | Queries the shadow information of a device. |
| UpdateDeviceShadow | Modifies the shadow information of a device. |
API operations for OTA updates
| API | Description |
|---|---|
| GenerateOTAUploadURL | Generates the URL and details of an update package to be uploaded to Object Storage Service (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 task. |
| CancelOTAStrategyByJob | Cancels an update policy that is related to a dynamic update task. |
| CancelOTATaskByDevice | Cancels the pending device update tasks of an update package. |
| CancelOTATaskByJob | Cancels the device update task of an update batch. |
| CreateOTAModule | Creats an OTA module for a product. |
| UpdateOTAModule | Modifies the alias of an OTA module. |
| DeleteOTAModule | Deletes a custom OTA module. |
| ListOTAModuleByProduct | Queries the OTA modules of a product. |