This topic lists the API operations for IoT Platform.
MQTT-based Enterprise instances support only some API operations for Product management, Device management, Server-side subscription, Data forwarding (new), Group management, and Messaging. For more information, see the last column in the corresponding API list.
Instance migration APIs
API | Description | Are MQTT instances supported? |
During instance migration, call this operation to perform a phased migration for new devices that have not been migrated. | No |
Product management APIs
API | Description | Support for MQTT instances |
Creates a product. | Yes. | |
Modifies product information. | Yes. | |
Queries a list of products. | Yes. | |
Queries the details of a product. | Yes. | |
Deletes a product. | Yes. | |
Creates product tags. | Yes. | |
Updates product tags. | Yes. | |
Deletes product tags. | Yes. | |
Queries all tags of a product. | Yes. | |
Queries products by tag. | Yes. | |
Updates the rule that is used to remove duplicate property data reported by devices of a product. | No. | |
Queries the X.509 certificate information of a product. | No. | |
Configures the X.509 certificate information for a product. | No. | |
Publishes a product. | Yes. | |
Cancels the publication of a product. | Yes. |
Device management APIs
Feature | API | Description | Support for MQTT instances |
Device registration | Refers to a single registered device. | No. | |
Registers multiple devices at a time. Device names are randomly generated. | No. | ||
Specifies custom names for multiple devices at a time. IoT Platform checks whether the names are valid. | No. | ||
Registers multiple devices at a time based on an ApplyId. | No. | ||
Queries the processing status and results of a batch device registration request. | Yes. | ||
Device lifecycle | Disables a device. | Yes. | |
You can unblock a device. | Yes. | ||
Resets a device. | Yes. | ||
Deletes a device. | Yes. | ||
Device ID | Queries the list of IDs for a single device in a registration-free, one-certificate-per-product scenario. | No. | |
Specifies a correct device ID to prevent unauthorized device logons in a registration-free, one-certificate-per-product scenario where a device has multiple device IDs. | No. | ||
In a registration-free, one-certificate-per-product scenario, deletes all IDs of a device if the number of IDs exceeds the limit of five. | No. | ||
Device information | Updates the nicknames of multiple devices at a time. | Yes. | |
Queries the basic information about a device, including the device ID, device certificate, and nickname. | Yes. | ||
Queries the details of a device. | Yes. | ||
Queries the details of multiple devices at a time. | Yes. | ||
Queries information about devices that are registered in a batch. | Yes. | ||
Queries the list of devices for a product. | Yes. | ||
Queries the status of a device. | Yes. | ||
Queries the status of multiple devices at a time. | Yes. | ||
Queries a list of devices by device status. | No. | ||
Queries the list of OTA module versions that are reported by a device. | No. | ||
Uses an SQL statement to quickly search for devices that meet specified conditions. | No. | ||
Queries device statistics. | Yes. | ||
Device tags | Configures device tags. | Yes. | |
Queries a list of device tags. | Yes. | ||
Queries devices by tag. | Yes. | ||
Deletes device tags. | Yes. | ||
Gateways and sub-devices | Adds topological relationships for multiple devices at a time. | No. | |
Notifies a gateway to add a topological relationship. | No. | ||
Queries the list of sub-devices for a gateway. | No. | ||
Queries the information about a gateway based on the information about an attached sub-device. | No. | ||
Removes the topological relationship of a gateway or sub-device. | No. | ||
LoRaWAN devices | Creates a task to register multiple LoRaWAN devices at a time. | No. | |
Queries the status of a task that is created to register multiple LoRaWAN devices at a time. | No. | ||
Queries the list of LoRaWAN join permissions for an Alibaba Cloud account. | No. | ||
Device X.509 certificates | Queries the X.509 certificate of a single device. | No. | |
Queries the download URL of the X.509 certificates for devices that are registered in a batch. | No. | ||
Cloud gateway devices | Imports a single device to an MQTT-based instance or MQTT cloud gateway product. | No. | |
Imports multiple devices to an MQTT-based instance or MQTT cloud gateway product at a time. | Yes. | ||
Verifies multiple devices that are imported to an MQTT-based instance or MQTT cloud gateway product at a time. | Yes. | ||
Queries the list of devices that are imported in a batch based on the application batch ID (ApplyId). | Yes. | ||
Imports multiple devices to a cloud gateway product that uses the JT/T 808, GB/T 32960, or SL 651 protocol at a time. | No. | ||
Verifies multiple imported devices of a cloud gateway product that uses the JT/T 808, GB/T 32960, or SL 651 protocol at a time. | No. | ||
Queries the information about a device of a cloud gateway product that uses the JT/T 808, GB/T 32960, or SL 651 protocol. | No. | ||
Device files | Queries all files that a device has uploaded to IoT Platform. | No. | |
Queries information about a file that a device has uploaded to IoT Platform. | No. | ||
Deletes a file that a device has uploaded to IoT Platform. | No. |
TSL model management APIs
API | Description | Support for MQTT instances |
Adds features to the Thing Specification Language (TSL) model of a product. You can also define extended information for the TSL model. | No. | |
Updates a feature in the TSL model of a product. You can also update the extended information of the TSL model. | ||
Queries the details of feature definitions in the TSL model of a product. | ||
Copies the TSL model of a product to a destination product. | ||
Publishes the TSL model of a product. | ||
Deletes a feature from the TSL model of a product. | ||
Queries the list of predefined product categories in IoT Platform. | ||
Queries the information about the standard TSL model of a category. | ||
Queries the list of historical versions of the TSL model for a product. | ||
Queries the TSL model of a product. | ||
Imports a TSL model for a product. Extended description configuration is not supported. | ||
Queries the details of feature definitions in the published TSL model of a product. | ||
Retrieves the published Thing Specification Language model of a specified product. | ||
Exports the extended description configuration of the TSL model for a product. | ||
Exports the extended description configuration of a published TSL model. | ||
Submits a data parsing script for a product. | ||
Modifies the data parsing script of a product. | ||
Queries the data parsing script of a product. |
TSL model usage APIs
API | Description | Are MQTT instances supported? |
Sets the properties of a device. | No. | |
Sets the properties of multiple devices at a time. | ||
Calls a service of a device. | ||
Calls the services of multiple devices at a time. | ||
Queries the historical data of device properties. | ||
Queries the historical data of multiple properties for a device at a time. | ||
Queries the historical data of device events. | ||
Queries the historical data of device service records. | ||
Sets the desired property values for a device at a time. | ||
Queries the desired property values of a device. | ||
Queries the property snapshot of a device. | ||
Queries the original property snapshot of a device. | ||
Queries the original property records of a device. | ||
Queries the original event records of a device. | ||
Queries the original service invocation records of a device. | ||
Deletes the desired property values that are set for a device. |
Topic management APIs
API | Description | MQTT-based instance support |
Creates a custom topic category for a product. | No. | |
Modifies a custom topic category of a product. | ||
Queries the custom topic categories of a product. | ||
Deletes a custom topic category of a product. | ||
Creates a route table for a topic. | ||
Queries the route table of a topic. | ||
Queries the reverse route table of a topic. | ||
Deletes the route table of a topic. |
Group management APIs
API | Description | Are MQTT instances supported? |
Creates a static group. | Yes. | |
Creates a dynamic group. | No. | |
Deletes a static group. | Yes. | |
Deletes a dynamic group. | No. | |
Modifies group information. | Yes. | |
Queries the details of a group. | Yes. | |
Performs a paged query to retrieve a list of groups. | Yes. | |
Queries the list of devices in a dynamic group. | No. | |
Adds devices to a static group. | Yes. | |
Removes specified devices from a group. | Yes. | |
Adds or updates group tags. | Yes. | |
Queries the list of group tags. | Yes. | |
Queries the list of groups to which a specified device belongs. | Yes. | |
Queries the parent group of a child group. | Yes. | |
Queries the list of devices in a group. | Yes. | |
Queries device groups based on tags. | Yes. |
APIs for device distribution
API | Description | Supported on MQTT instances |
Creates a device distribution task. By default, the device's product is also distributed. | No. | |
Creates a product distribution task to distribute a specified product to a specified target instance. | ||
Retrieves the results of a completed device distribution task. | ||
Retrieves the details of a device distribution task. | ||
Retrieves a list of device distribution tasks. | ||
Deletes a device distribution task. | ||
Queries the list of distributed devices. | ||
Gets a list of distributed products. | ||
Query the distribution results for a specified device. |
Device Shadow APIs
API | Description | Supported on MQTT instances |
Queries the device shadow. | No. | |
Updates the device shadow. |
Message communication APIs
API | Description | Support for MQTT instances |
Subscribes a specified device to a topic. | No. | |
Cancels the subscription to a specified topic for a specified device. | No | |
Queries the list of subscribed topics for a device. | No. | |
Specifies whether a custom topic supports broadcasting retained messages. | Yes | |
Publishes messages to specific devices using custom topics. You can also broadcast messages to online devices of a product that have subscribed to a specific custom topic. | Yes. | |
Sends messages to multiple devices of a specified product in a batch using a custom topic. | Yes. | |
Publishes a broadcast message to all devices of a specified product or all devices that are subscribed to a specified topic. | No. | |
Sends a request message to a specified device and synchronously returns a response. | No. | |
Sends a message to a specific device. | Yes. | |
Queries the details of a device's uplink and downlink messages, such as the message content, timestamp, and message topic. | Yes. |
Server-side subscription API
API | Description | Support for MQTT instances |
Creates an MNS or AMQP server-side subscription. | Yes. | |
Modifies an MNS or AMQP server-side subscription. | Yes. | |
Queries MNS or AMQP server-side subscriptions. | Yes. | |
Deletes an MNS or AMQP server-side subscription. | Yes. | |
Creates a consumer group for AMQP server-side subscriptions. | Yes. | |
Updates the name of a consumer group. | Yes. | |
Queries the details of a consumer group by its ID. | Yes. | |
Queries a list of all consumer groups or performs a fuzzy query for consumer groups by name. | Yes. | |
Queries the status of a consumer group for an AMQP server-side subscription. The status includes information about online clients, the message consumption rate, message accumulation, and the time of the most recent message consumption. | Yes. | |
Clears the accumulated messages in a consumer group for an AMQP server-side subscription. | Yes. | |
Deletes a consumer group. | Yes. | |
Adds a consumer group to an AMQP subscription. | Yes. | |
Removes a consumer group from an AMQP subscription. | Yes. |
Data Forwarding (Legacy) APIs
API | Description | Supported on MQTT instances |
Create a rule. | No. | |
Creates a rule action. | ||
Deletes a rule. | ||
The action to delete a rule. | ||
Queries information about a rule. | ||
Queries information about a rule action. | ||
Queries the list of rules. | ||
Queries a list of rule actions. | ||
Updates a rule. | ||
Updates the rule action. | ||
Starts the rule. | ||
Stops the rule. |
APIs for data forwarding (new version)
Feature | API | Description | Are MQTT instances supported? |
Parser | Creates a parser. | Yes. | |
Updates the name and description of a parser. | Yes. | ||
Queries a list of parsers. The list includes the basic information, running status, creation time, and modification time of each parser. | Yes. | ||
Queries the details of a specific parser. The details include the basic information, parsing script, running status, and associated data sources. | Yes. | ||
Deletes a parser. | Yes. | ||
Data source | Creates a data source for data forwarding. | Yes. | |
Updates the name and description of a data source. | Yes. | ||
Queries a list of all data sources. | Yes. | ||
Queries the details of a specific data source. | Yes. | ||
Deletes a data source. | Yes. | ||
Data source topic | Adds a topic to a data source. | Yes. | |
Performs a paged query to retrieve the list of topics for a specific data source. | Yes. | ||
Deletes a topic from a data source. | Yes. | ||
Data destination | Creates a data destination for data forwarding. | Yes. | |
Updates the name, operation type, and description of a data destination. | Yes. | ||
Queries the list of data destinations. | Yes. | ||
Queries the details of a specific data destination. | Yes. | ||
Deletes a data destination. | Yes. | ||
Configure parser | Associates a parser with a data source. | Yes. | |
Queries the list of data destinations that are associated with a parser. | Yes. | ||
Detaches a data source from a parser. | Yes. | ||
Associates a parser with a data destination. | Yes. | ||
Detaches a data destination from a parser. | Yes. | ||
Edits and saves the script draft for a parser. | Yes. | ||
Publishes the script of a parser. | Yes. | ||
Starts a parser. | Yes. | ||
Stops a parser. | Yes. |
Data service APIs
API | Description | Support for MQTT instances |
Writes data from custom device topics to hot data storage. | No. | |
Queries snapshot data from hot data storage. | ||
Queries time series data from hot data storage. | ||
Deletes the stored time series data for a specified device. | ||
Creates a data algorithm service API. | ||
Gets the details of a data algorithm service API. | ||
Invokes a data algorithm service API to get SQL query results. | ||
Executes the query task for a data service API to get specified data from a data source. | ||
Imports external data to IoT Platform. You can upload data from local servers or other platforms to IoT Platform for analysis and processing. | ||
Imports external data to IoT Platform in batches. | ||
Creates a data download task. | ||
Gets the result of a task that downloads data from a data table. |
Secure tunnel APIs
API | Description | Support for MQTT instances |
Creates a secure tunnel. | No. | |
Closes an open secure tunnel. | ||
Deletes a closed secure tunnel. | ||
Queries the details of a specific secure tunnel. Details include the associated device, creation time, ID, and connection status. |
OTA update APIs
API | Description | Supported on MQTT-based instances |
Generates the URL and details to upload an upgrade package file to Object Storage Service (OSS). | No. | |
Generates the URL and details to upload a device list file to OSS. When you create a static upgrade batch, use the device list file to specify the devices to upgrade. | ||
Adds an upgrade package. | ||
Modifies upgrade package information, such as the package name, description, and custom information. | ||
Deletes a specified upgrade package. | ||
Queries a list of upgrade packages. | ||
Queries the details of a specified upgrade package. | ||
Creates a verification batch for an upgrade package. | ||
Creates a static upgrade batch. | ||
Creates a dynamic upgrade batch. | ||
Updates the configurations of static and dynamic upgrade batches. | ||
Queries a list of upgrade batches for an upgrade package. | ||
Queries the upgrade batches that contain a specified device. | ||
Queries a list of device upgrade jobs in a specified upgrade batch. | ||
Queries the details of a specified upgrade batch. | ||
Cancels the dynamic upgrade policy that is associated with a dynamic upgrade batch. | ||
Cancels pending device upgrade jobs for a specified upgrade package. | ||
Cancels the device upgrade jobs in a specified batch. | ||
Creates an over-the-air (OTA) module for a product. | ||
Modifies the alias and description of an OTA module. | ||
Deletes a custom OTA module. | ||
Queries a list of OTA modules for a product. | ||
Confirms device upgrade jobs that are in the To be confirmed state. | ||
Queries a list of unfinished device upgrade jobs for a specified device. | ||
Reruns failed or canceled device upgrade jobs in a specified batch. | ||
Queries a list of OTA module versions that are reported by a device. |
Device job APIs
API | Description | MQTT instance support |
Creates a device job. | No. | |
Generates information to upload a file to OSS. | ||
Updates the task configuration for a job. | ||
Queries the details of a specific device job. | ||
Queries the list of jobs in an Alibaba Cloud account. | ||
Cancels a job. | ||
Deletes a device job. | ||
Retrieves a list of jobs for a specified task or device. | ||
Queries the jobs associated with a specified task. | ||
Queries job statistics for each status in a specified task. | ||
Reruns all timed-out and failed tasks in a specific device job. |
APIs for value-added services
APIs for Real-Time Communication service
API | Description | Support for MQTT instances |
Grants a license to a specified product. | No | |
Grants licenses to a batch of devices that belong to a specified product. | ||
Queries the progress of a batch authorization task based on the unique ID (CheckProgressId). | ||
Queries the list of devices that are granted licenses. | ||
Cancels the license authorization for a specified product. |
APIs of the IoT Digital Twin engine
API | Description | Are MQTT instances supported? |
Triggers the data mapping configuration of a digital twin to map data to a digital twin node. | No |
APIs for the location service
API | Description | Supported on MQTT-based instances |
Queries device location information. | No. | |
Queries device trace details. |
Voice Messaging APIs
API | Description | Are MQTT instances supported? |
Grants a license to devices of a specified product. | No. | |
Queries the progress of a batch authorization task based on the unique ID (CheckProgressId) returned by the API. | ||
Queries the remaining quota of the current license. | ||
You can create a corpus. | ||
Updates speech, including the voice, speed, and volume. | ||
Gets the voice for speech playback. | ||
You can preview the audio. | ||
Queries the details of speech, such as the voice, type, and volume. | ||
You can query the corpus list. | ||
You can push the corpus to the device. | ||
Deletes speech. | ||
Queries the list of groups in a project. | ||
You can query the list of corpus push tasks. | ||
Queries the devices in a specified speech push task. | ||
Queries the details of speech in a push task, such as the voice, type, and text. | ||
Combine the scripts on the broadcast device. | ||
You can synchronize the content on the group broadcast devices. | ||
Sends dynamic content to a device for playback. | ||
Queries the free space of a speech device. | ||
Queries the list of speech on a device. | ||
Queries the details of a speech device, such as the status and free space. | ||
You can delete the corpus from the device. | ||
Pushes shared audio to a device for playback. | ||
Adds a device to a speech sharing task. | ||
Queries the list of devices in a speech sharing task. | ||
Deletes a device from a speech sharing task. | ||
Queries the list of devices that have a Voice Messaging license. | ||
Queries the statistics information of devices that have a Voice Messaging license. | ||
Queries the list of shared devices in a project. | ||
Performs a paged query for the hourly data of shared broadcasts in Voice Messaging. | ||
Performs a paged query for the hourly data volume of shared broadcasts in Voice Messaging. | ||
The recipient retrieves shared corpora through a paged query. | ||
Queries a sharing task based on device information. | ||
Gets the audio file of shared speech. | ||
Creates a promotion for a Voice Messaging sharing task. | ||
Queries the audit result of a promotion for a Voice Messaging sharing task. | ||
Creates shared speech for a promotion of a Voice Messaging sharing task. | ||
Adds an existing shared device from a Voice Messaging sharing task to a promotion. | ||
Queries the name of the product to which a shared device belongs in a sharing task based on the ProductKey. |
Message Delivery Service API
API | Description | Supported on MQTT-based instances |
You can use the receipt printing template that you created in the Jiyan Chuanshu console to print receipts. | No. |
API for activating the service
OpenIotService: Activates IoT Platform.
Other APIs
For more information about calling the cloud APIs for IoT Edge, see Edge computing APIs.