API list

更新时间:
复制 MD 格式

This topic lists the API operations for IoT Platform.

Important

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?

BatchGrayMigrationDevice

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

CreateProduct

Creates a product.

Yes.

UpdateProduct

Modifies product information.

Yes.

QueryProductList

Queries a list of products.

Yes.

QueryProduct

Queries the details of a product.

Yes.

DeleteProduct

Deletes a product.

Yes.

CreateProductTags

Creates product tags.

Yes.

UpdateProductTags

Updates product tags.

Yes.

DeleteProductTags

Deletes product tags.

Yes.

ListProductTags

Queries all tags of a product.

Yes.

ListProductByTags

Queries products by tag.

Yes.

UpdateProductFilterConfig

Updates the rule that is used to remove duplicate property data reported by devices of a product.

No.

QueryProductCertInfo

Queries the X.509 certificate information of a product.

No.

SetProductCertInfo

Configures the X.509 certificate information for a product.

No.

ReleaseProduct

Publishes a product.

Yes.

CancelReleaseProduct

Cancels the publication of a product.

Yes.

Device management APIs

Feature

API

Description

Support for MQTT instances

Device registration

RegisterDevice

Refers to a single registered device.

No.

BatchRegisterDevice

Registers multiple devices at a time. Device names are randomly generated.

No.

BatchCheckDeviceNames

Specifies custom names for multiple devices at a time. IoT Platform checks whether the names are valid.

No.

BatchRegisterDeviceWithApplyId

Registers multiple devices at a time based on an ApplyId.

No.

QueryBatchRegisterDeviceStatus

Queries the processing status and results of a batch device registration request.

Yes.

Device lifecycle

DisableThing

Disables a device.

Yes.

EnableThing

You can unblock a device.

Yes.

ResetThing

Resets a device.

Yes.

DeleteDevice

Deletes a device.

Yes.

Device ID

QueryClientIds

Queries the list of IDs for a single device in a registration-free, one-certificate-per-product scenario.

No.

TransformClientId

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.

DeleteClientIds

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

BatchUpdateDeviceNickname

Updates the nicknames of multiple devices at a time.

Yes.

QueryDeviceInfo

Queries the basic information about a device, including the device ID, device certificate, and nickname.

Yes.

QueryDeviceDetail

Queries the details of a device.

Yes.

BatchQueryDeviceDetail

Queries the details of multiple devices at a time.

Yes.

QueryPageByApplyId

Queries information about devices that are registered in a batch.

Yes.

QueryDevice

Queries the list of devices for a product.

Yes.

GetDeviceStatus

Queries the status of a device.

Yes.

BatchGetDeviceState

Queries the status of multiple devices at a time.

Yes.

QueryDeviceByStatus

Queries a list of devices by device status.

No.

ListOTAModuleVersionsByDevice

Queries the list of OTA module versions that are reported by a device.

No.

QueryDeviceBySQL

Uses an SQL statement to quickly search for devices that meet specified conditions.

No.

QueryDeviceStatistics

Queries device statistics.

Yes.

Device tags

SaveDeviceProp

Configures device tags.

Yes.

QueryDeviceProp

Queries a list of device tags.

Yes.

QueryDeviceByTags

Queries devices by tag.

Yes.

DeleteDeviceProp

Deletes device tags.

Yes.

Gateways and sub-devices

BatchAddThingTopo

Adds topological relationships for multiple devices at a time.

No.

NotifyAddThingTopo

Notifies a gateway to add a topological relationship.

No.

GetThingTopo

Queries the list of sub-devices for a gateway.

No.

GetGatewayBySubDevice

Queries the information about a gateway based on the information about an attached sub-device.

No.

RemoveThingTopo

Removes the topological relationship of a gateway or sub-device.

No.

LoRaWAN devices

CreateLoRaNodesTask

Creates a task to register multiple LoRaWAN devices at a time.

No.

GetLoraNodesTask

Queries the status of a task that is created to register multiple LoRaWAN devices at a time.

No.

QueryLoRaJoinPermissions

Queries the list of LoRaWAN join permissions for an Alibaba Cloud account.

No.

Device X.509 certificates

QueryDeviceCert

Queries the X.509 certificate of a single device.

No.

QueryCertUrlByApplyId

Queries the download URL of the X.509 certificates for devices that are registered in a batch.

No.

Cloud gateway devices

ImportDevice

Imports a single device to an MQTT-based instance or MQTT cloud gateway product.

No.

BatchImportDevice

Imports multiple devices to an MQTT-based instance or MQTT cloud gateway product at a time.

Yes.

BatchCheckImportDevice

Verifies multiple devices that are imported to an MQTT-based instance or MQTT cloud gateway product at a time.

Yes.

QueryImportedDeviceByApplyId

Queries the list of devices that are imported in a batch based on the application batch ID (ApplyId).

Yes.

BatchImportVehicleDevice

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.

BatchCheckVehicleDevice

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.

QueryVehicleDevice

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

QueryDeviceFileList

Queries all files that a device has uploaded to IoT Platform.

No.

QueryDeviceFile

Queries information about a file that a device has uploaded to IoT Platform.

No.

DeleteDeviceFile

Deletes a file that a device has uploaded to IoT Platform.

No.

TSL model management APIs

API

Description

Support for MQTT instances

CreateThingModel

Adds features to the Thing Specification Language (TSL) model of a product. You can also define extended information for the TSL model.

No.

UpdateThingModel

Updates a feature in the TSL model of a product. You can also update the extended information of the TSL model.

QueryThingModel

Queries the details of feature definitions in the TSL model of a product.

CopyThingModel

Copies the TSL model of a product to a destination product.

PublishThingModel

Publishes the TSL model of a product.

DeleteThingModel

Deletes a feature from the TSL model of a product.

ListThingTemplates

Queries the list of predefined product categories in IoT Platform.

GetThingTemplate

Queries the information about the standard TSL model of a category.

ListThingModelVersion

Queries the list of historical versions of the TSL model for a product.

GetThingModelTsl

Queries the TSL model of a product.

ImportThingModelTsl

Imports a TSL model for a product. Extended description configuration is not supported.

QueryThingModelPublished

Queries the details of feature definitions in the published TSL model of a product.

GetThingModelTslPublished

Retrieves the published Thing Specification Language model of a specified product.

QueryThingModelExtendConfig

Exports the extended description configuration of the TSL model for a product.

QueryThingModelExtendConfigPublished

Exports the extended description configuration of a published TSL model.

CreateThingScript

Submits a data parsing script for a product.

UpdateThingScript

Modifies the data parsing script of a product.

GetThingScript

Queries the data parsing script of a product.

TSL model usage APIs

API

Description

Are MQTT instances supported?

SetDeviceProperty

Sets the properties of a device.

No.

SetDevicesProperty

Sets the properties of multiple devices at a time.

InvokeThingService

Calls a service of a device.

InvokeThingsService

Calls the services of multiple devices at a time.

QueryDevicePropertyData

Queries the historical data of device properties.

QueryDevicePropertiesData

Queries the historical data of multiple properties for a device at a time.

QueryDeviceEventData

Queries the historical data of device events.

QueryDeviceServiceData

Queries the historical data of device service records.

SetDeviceDesiredProperty

Sets the desired property values for a device at a time.

QueryDeviceDesiredProperty

Queries the desired property values of a device.

QueryDevicePropertyStatus

Queries the property snapshot of a device.

QueryDeviceOriginalPropertyStatus

Queries the original property snapshot 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 invocation records of a device.

ClearDeviceDesiredProperty

Deletes the desired property values that are set for a device.

Topic management APIs

API

Description

MQTT-based instance support

CreateProductTopic

Creates a custom topic category for a product.

No.

UpdateProductTopic

Modifies a custom topic category of a product.

QueryProductTopic

Queries the custom topic categories of a product.

DeleteProductTopic

Deletes a custom topic category of a product.

CreateTopicRouteTable

Creates a route table for a topic.

QueryTopicRouteTable

Queries the route table of a topic.

QueryTopicReverseRouteTable

Queries the reverse route table of a topic.

DeleteTopicRouteTable

Deletes the route table of a topic.

Group management APIs

API

Description

Are MQTT instances supported?

CreateDeviceGroup

Creates a static group.

Yes.

CreateDeviceDynamicGroup

Creates a dynamic group.

No.

DeleteDeviceGroup

Deletes a static group.

Yes.

DeleteDeviceDynamicGroup

Deletes a dynamic group.

No.

UpdateDeviceGroup

Modifies group information.

Yes.

QueryDeviceGroupInfo

Queries the details of a group.

Yes.

QueryDeviceGroupList

Performs a paged query to retrieve a list of groups.

Yes.

QueryDynamicGroupDevices

Queries the list of devices in a dynamic group.

No.

BatchAddDeviceGroupRelations

Adds devices to a static group.

Yes.

BatchDeleteDeviceGroupRelations

Removes specified devices from a group.

Yes.

SetDeviceGroupTags

Adds or updates group tags.

Yes.

QueryDeviceGroupTagList

Queries the list of group tags.

Yes.

QueryDeviceGroupByDevice

Queries the list of groups to which a specified device belongs.

Yes.

QuerySuperDeviceGroup

Queries the parent group of a child group.

Yes.

QueryDeviceListByDeviceGroup

Queries the list of devices in a group.

Yes.

QueryDeviceGroupByTags

Queries device groups based on tags.

Yes.

APIs for device distribution

API

Description

Supported on MQTT instances

CreateDeviceDistributeJob

Creates a device distribution task. By default, the device's product is also distributed.

No.

CreateProductDistributeJob

Creates a product distribution task to distribute a specified product to a specified target instance.

QueryDeviceDistributeDetail

Retrieves the results of a completed device distribution task.

QueryDeviceDistributeJob

Retrieves the details of a device distribution task.

ListDeviceDistributeJob

Retrieves a list of device distribution tasks.

DeleteDeviceDistributeJob

Deletes a device distribution task.

ListDistributedDevice

Queries the list of distributed devices.

ListDistributedProduct

Gets a list of distributed products.

QueryDeviceProvisioning

Query the distribution results for a specified device.

Device Shadow APIs

API

Description

Supported on MQTT instances

GetDeviceShadow

Queries the device shadow.

No.

UpdateDeviceShadow

Updates the device shadow.

Message communication APIs

API

Description

Support for MQTT instances

SubscribeTopic

Subscribes a specified device to a topic.

No.

UnsubscribeTopic

Cancels the subscription to a specified topic for a specified device.

No

QueryDeviceSubTopic

Queries the list of subscribed topics for a device.

No.

UpdateTopicConfig

Specifies whether a custom topic supports broadcasting retained messages.

Yes

Pub

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.

BatchPub

Sends messages to multiple devices of a specified product in a batch using a custom topic.

Yes.

PubBroadcast

Publishes a broadcast message to all devices of a specified product or all devices that are subscribed to a specified topic.

No.

RRpc

Sends a request message to a specified device and synchronously returns a response.

No.

AsyncRRpc

Sends a message to a specific device.

Yes.

QueryMessageInfo

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

CreateSubscribeRelation

Creates an MNS or AMQP server-side subscription.

Yes.

UpdateSubscribeRelation

Modifies an MNS or AMQP server-side subscription.

Yes.

QuerySubscribeRelation

Queries MNS or AMQP server-side subscriptions.

Yes.

DeleteSubscribeRelation

Deletes an MNS or AMQP server-side subscription.

Yes.

CreateConsumerGroup

Creates a consumer group for AMQP server-side subscriptions.

Yes.

UpdateConsumerGroup

Updates the name of a consumer group.

Yes.

QueryConsumerGroupByGroupId

Queries the details of a consumer group by its ID.

Yes.

QueryConsumerGroupList

Queries a list of all consumer groups or performs a fuzzy query for consumer groups by name.

Yes.

QueryConsumerGroupStatus

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.

ResetConsumerGroupPosition

Clears the accumulated messages in a consumer group for an AMQP server-side subscription.

Yes.

DeleteConsumerGroup

Deletes a consumer group.

Yes.

CreateConsumerGroupSubscribeRelation

Adds a consumer group to an AMQP subscription.

Yes.

DeleteConsumerGroupSubscribeRelation

Removes a consumer group from an AMQP subscription.

Yes.

Data Forwarding (Legacy) APIs

API

Description

Supported on MQTT instances

CreateRule

Create a rule.

No.

CreateRuleAction

Creates a rule action.

DeleteRule

Deletes a rule.

DeleteRuleAction

The action to delete a rule.

GetRule

Queries information about a rule.

GetRuleAction

Queries information about a rule action.

ListRule

Queries the list of rules.

ListRuleActions

Queries a list of rule actions.

UpdateRule

Updates a rule.

UpdateRuleAction

Updates the rule action.

StartRule

Starts the rule.

StopRule

Stops the rule.

APIs for data forwarding (new version)

Feature

API

Description

Are MQTT instances supported?

Parser

CreateParser

Creates a parser.

Yes.

UpdateParser

Updates the name and description of a parser.

Yes.

ListParser

Queries a list of parsers. The list includes the basic information, running status, creation time, and modification time of each parser.

Yes.

GetParser

Queries the details of a specific parser. The details include the basic information, parsing script, running status, and associated data sources.

Yes.

DeleteParser

Deletes a parser.

Yes.

Data source

CreateParserDataSource

Creates a data source for data forwarding.

Yes.

UpdateParserDataSource

Updates the name and description of a data source.

Yes.

ListParserDataSource

Queries a list of all data sources.

Yes.

GetParserDataSource

Queries the details of a specific data source.

Yes.

DeleteParserDataSource

Deletes a data source.

Yes.

Data source topic

CreateDataSourceItem

Adds a topic to a data source.

Yes.

ListDataSourceItem

Performs a paged query to retrieve the list of topics for a specific data source.

Yes.

DeleteDataSourceItem

Deletes a topic from a data source.

Yes.

Data destination

CreateDestination

Creates a data destination for data forwarding.

Yes.

UpdateDestination

Updates the name, operation type, and description of a data destination.

Yes.

ListDestination

Queries the list of data destinations.

Yes.

GetDestination

Queries the details of a specific data destination.

Yes.

DeleteDestination

Deletes a data destination.

Yes.

Configure parser

AttachParserDataSource

Associates a parser with a data source.

Yes.

ListParserDestination

Queries the list of data destinations that are associated with a parser.

Yes.

DetachParserDataSource

Detaches a data source from a parser.

Yes.

AttachDestination

Associates a parser with a data destination.

Yes.

DetachDestination

Detaches a data destination from a parser.

Yes.

SaveScript

Edits and saves the script draft for a parser.

Yes.

PublishScript

Publishes the script of a parser.

Yes.

StartParser

Starts a parser.

Yes.

StopParser

Stops a parser.

Yes.

Data service APIs

API

Description

Support for MQTT instances

WriteDevicesHotStorageData

Writes data from custom device topics to hot data storage.

No.

QueryDevicesHotStorageDataStatus

Queries snapshot data from hot data storage.

QueryDevicesHotStorageData

Queries time series data from hot data storage.

ResetDeviceTimeline

Deletes the stored time series data for a specified device.

CreateDataAPIService

Creates a data algorithm service API.

GetDataAPIServiceDetail

Gets the details of a data algorithm service API.

InvokeDataAPIService

Invokes a data algorithm service API to get SQL query results.

ListAnalyticsData

Executes the query task for a data service API to get specified data from a data source.

AddDataForApiSource

Imports external data to IoT Platform. You can upload data from local servers or other platforms to IoT Platform for analysis and processing.

BatchAddDataForApiSource

Imports external data to IoT Platform in batches.

CreateDownloadDataJob

Creates a data download task.

GetDownloadFile

Gets the result of a task that downloads data from a data table.

Secure tunnel APIs

API

Description

Support for MQTT instances

CreateDeviceTunnel

Creates a secure tunnel.

No.

CloseDeviceTunnel

Closes an open secure tunnel.

DeleteDeviceTunnel

Deletes a closed secure tunnel.

QueryDeviceTunnel

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

GenerateOTAUploadURL

Generates the URL and details to upload an upgrade package file to Object Storage Service (OSS).

No.

GenerateDeviceNameListURL

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.

CreateOTAFirmware

Adds an upgrade package.

ModifyOTAFirmware

Modifies upgrade package information, such as the package name, description, and custom information.

DeleteOTAFirmware

Deletes a specified upgrade package.

ListOTAFirmware

Queries a list of upgrade packages.

QueryOTAFirmware

Queries the details of a specified upgrade package.

CreateOTAVerifyJob

Creates a verification batch for an upgrade package.

CreateOTAStaticUpgradeJob

Creates a static upgrade batch.

CreateOTADynamicUpgradeJob

Creates a dynamic upgrade batch.

UpdateOTAJob

Updates the configurations of static and dynamic upgrade batches.

ListOTAJobByFirmware

Queries a list of upgrade batches for an upgrade package.

ListOTAJobByDevice

Queries the upgrade batches that contain a specified device.

ListOTATaskByJob

Queries a list of device upgrade jobs in a specified upgrade batch.

QueryOTAJob

Queries the details of a specified upgrade batch.

CancelOTAStrategyByJob

Cancels the dynamic upgrade policy that is associated with a dynamic upgrade batch.

CancelOTATaskByDevice

Cancels pending device upgrade jobs for a specified upgrade package.

CancelOTATaskByJob

Cancels the device upgrade jobs in a specified batch.

CreateOTAModule

Creates an over-the-air (OTA) module for a product.

UpdateOTAModule

Modifies the alias and description of an OTA module.

DeleteOTAModule

Deletes a custom OTA module.

ListOTAModuleByProduct

Queries a list of OTA modules for a product.

ConfirmOTATask

Confirms device upgrade jobs that are in the To be confirmed state.

ListOTAUnfinishedTaskByDevice

Queries a list of unfinished device upgrade jobs for a specified device.

ReupgradeOTATask

Reruns failed or canceled device upgrade jobs in a specified batch.

ListOTAModuleVersionsByDevice

Queries a list of OTA module versions that are reported by a device.

Device job APIs

API

Description

MQTT instance support

CreateJob

Creates a device job.

No.

GenerateFileUploadURL

Generates information to upload a file to OSS.

UpdateJob

Updates the task configuration for a job.

QueryJob

Queries the details of a specific device job.

ListJob

Queries the list of jobs in an Alibaba Cloud account.

CancelJob

Cancels a job.

DeleteJob

Deletes a device job.

ListTask

Retrieves a list of jobs for a specified task or device.

QueryTask

Queries the jobs associated with a specified task.

QueryJobStatistics

Queries job statistics for each status in a specified task.

RerunJob

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

BindLicenseProduct

Grants a license to a specified product.

No

BindLicenseDevice

Grants licenses to a batch of devices that belong to a specified product.

CheckBindLicenseDeviceProgress

Queries the progress of a batch authorization task based on the unique ID (CheckProgressId).

QueryLicenseDeviceList

Queries the list of devices that are granted licenses.

UnbindLicenseProduct

Cancels the license authorization for a specified product.

APIs of the IoT Digital Twin engine

API

Description

Are MQTT instances supported?

ImportDTData

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

GisQueryDeviceLocation

Queries device location information.

No.

GisSearchDeviceTrace

Queries device trace details.

Voice Messaging APIs

API

Description

Are MQTT instances supported?

BindLicenseDevice

Grants a license to devices of a specified product.

No.

CheckBindLicenseDeviceProgress

Queries the progress of a batch authorization task based on the unique ID (CheckProgressId) returned by the API.

QuerySpeechLicenseAvailableQuota

Queries the remaining quota of the current license.

CreateSpeech

You can create a corpus.

UpdateSpeech

Updates speech, including the voice, speed, and volume.

GetSpeechVoice

Gets the voice for speech playback.

TestSpeech

You can preview the audio.

QuerySpeech

Queries the details of speech, such as the voice, type, and volume.

QuerySpeechList

You can query the corpus list.

PushSpeech

You can push the corpus to the device.

DeleteSpeech

Deletes speech.

QuerySolutionDeviceGroupPage

Queries the list of groups in a project.

QuerySpeechPushJob

You can query the list of corpus push tasks.

QuerySpeechPushJobDevice

Queries the devices in a specified speech push task.

QuerySpeechPushJobSpeech

Queries the details of speech in a push task, such as the voice, type, and text.

SpeechByCombination

Combine the scripts on the broadcast device.

SyncSpeechByCombination

You can synchronize the content on the group broadcast devices.

SpeechBySynthesis

Sends dynamic content to a device for playback.

QuerySpeechDevice

Queries the free space of a speech device.

QueryDeviceSpeech

Queries the list of speech on a device.

GetSpeechDeviceDetail

Queries the details of a speech device, such as the status and free space.

DeleteDeviceSpeech

You can delete the corpus from the device.

ShareSpeechByCombination

Pushes shared audio to a device for playback.

AddShareTaskDevice

Adds a device to a speech sharing task.

QueryShareTaskDeviceList

Queries the list of devices in a speech sharing task.

DeleteShareTaskDevice

Deletes a device from a speech sharing task.

QuerySpeechLicenseDeviceList

Queries the list of devices that have a Voice Messaging license.

GetSpeechLicenseDeviceStatistics

Queries the statistics information of devices that have a Voice Messaging license.

QueryProjectShareDeviceList

Queries the list of shared devices in a project.

PageQuerySpeechBroadcastHour

Performs a paged query for the hourly data of shared broadcasts in Voice Messaging.

CountSpeechBroadcastHour

Performs a paged query for the hourly data volume of shared broadcasts in Voice Messaging.

PageQuerySharedSpeechOpen

The recipient retrieves shared corpora through a paged query.

GetShareTaskByDeviceOpen

Queries a sharing task based on device information.

GetShareSpeechModelAudio

Gets the audio file of shared speech.

CreateSharePromotionActivity

Creates a promotion for a Voice Messaging sharing task.

QuerySharePromotionActivityAuditResult

Queries the audit result of a promotion for a Voice Messaging sharing task.

CreateSharePromotionSpeechModel

Creates shared speech for a promotion of a Voice Messaging sharing task.

AddDeviceToSharePromotion

Adds an existing shared device from a Voice Messaging sharing task to a promotion.

QueryShareProductNameByProductKey

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

PrintByTemplate

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.