The following tables list the API operations that are available for use in IoT Platform.
API operations for product management
| API | Description |
|---|---|
| CreateProduct | Creates a product. |
| UpdateProduct | Modifies the information of a product. |
| QueryProductList | Queries all products of an account. |
| QueryProduct | Queries the details of a product. |
| DeleteProduct | Deletes a product. |
| CreateProductTags | Creates tags for a product. |
| UpdateProductTags | Modifies the tags of a product. |
| DeleteProductTags | Deletes the tags of a product. |
| ListProductTags | Queries all tags of a product. |
| ListProductByTags | Queries products of an account by tags. |
| UpdateProductFilterConfig | Modifies the deduplication rule for property messages that are reported by devices of a product. |
API operations for device management
| API | Description |
|---|---|
| RegisterDevice | Registers a device. |
| QueryDeviceDetail | Queries the details of a device. |
| BatchQueryDeviceDetail | Queries the details of multiple devices. |
| QueryDevice | Queries all devices of a product. |
| DeleteDevice | Deletes a device. |
| GetDeviceStatus | Retrieves the status of a device. |
| BatchGetDeviceState | Retrieves the status of multiple devices. |
| DisableThing | Disables a device. |
| EnableThing | Enables a device. |
| ResetThing | Resets a device. |
| BatchCheckDeviceNames | Checks whether the names of the devices that you want to register are valid. |
| BatchRegisterDeviceWithApplyId | Registers multiple devices by using an application ID (ApplyId). |
| BatchRegisterDevice | Registers multiple devices. |
| QueryBatchRegisterDeviceStatus | Queries the status of the application to register multiple devices. |
| QueryPageByApplyId | Queries the information of devices that you have registered at a time. |
| 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 device. |
| NotifyAddThingTopo | Notifies a gateway to build a topological relationship with sub-devices. |
| BatchAddTingTopo | Builds a topological relationship with multiple devices. |
| RemoveThingTopo | Removes the topological relationships of a device. |
| QueryDeviceStatistics | Queries the device statistics of a product. |
| 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 group management
| 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 updates 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) management
| API | Description |
|---|---|
| CreateThingModel | Adds TSL features for a product, or adds the extended information of the TSL. |
| UpdateThingModel | Modifies a TSL feature of a product, or updates the extended information of the TSL. |
| QueryThingModel | Queries the feature details of the TSL of a product. |
| CopyThingModel | Copies the TSL of a product to a destination product. |
| PublishThingModel | Publishes the TSL of a product. |
| DeleteThingModel | Removes a TSL feature from a product. |
| ListThingTemplates | Retrieves all product categories that are predefined in IoT Platform. |
| GetThingTemplate | Queries the standard TSL information of a category. |
| ListThingModelVersion | Retrieves a list of the TSL versions of a product. |
| GetThingModelTsl | Queries the TSL of a product. |
| ImportThingModelTsl | Imports a TSL for a product. Extended TSL information cannot be imported. |
| QueryThingModelPublished | Queries the feature details of the published TSL of a product. |
| GetThingModelTslPublished | Queries the information of the published TSL of a product. |
| QueryThingModelExtendConfig | Queries the extended information of the TSL of 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 all rules. |
| CreateRule | Creates a rule. |
| GetRule | Queries the details of a rule. |
| UpdateRule | Modifies a rule. |
| DeleteRule | Deletes a rule. |
| ListRuleActions | Queries all actions of a rule. |
| 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 topic management
| API | Description |
|---|---|
| QueryProductTopic | Queries information about all 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 subscription
| 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 consumer groups of the account, or performs a fuzzy search by consumer group name. |
| QueryConsumerGroupStatus | Queries the status of a consumer group when 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 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 communications
| API | Description |
|---|---|
| Pub | Publishes messages to topics. |
| 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 firmware update
| API | Description |
|---|---|
| GenerateOTAUploadURL | Generates the information that is used to upload firmware file to Object Storage Service (OSS). |
| CreateOTAFirmware | Creates a firmware component. |
| DeleteOTAFirmware | Deletes a firmware component. |
| ListOTAFirmware | Queries all firmware components. |
| QueryOTAFirmware | Queries the details of a firmware component. |
| CreateOTAVerifyJob | Creates a firmware verification task. |
| CreateOTAStaticUpgradeJob | Creates a static update task. |
| CreateOTADynamicUpgradeJob | Creates a dynamic update task. |
| ListOTAJobByFirmware | Queries the update tasks of a firmware component. |
| ListOTAJobByDevice | Queries all firmware update tasks of a device. |
| 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 a firmware component. |
| CancelOTATaskByJob | Cancels an update task. |
| ListOTATaskByJob | Queries an update task. |