Change History

2025-02-28

This issue is the twenty-fourth official release.

Newly added:

• Modify a Device Gateway

2024-11-26

This issue is the twenty-third official release.

Newly added:

• Query a Command in the Queue of a Device
• Query a Historical Device Command
• Collects Statistics on the Total Number of Historical Commands of a Device
• Create a Codec Function
• Query a Codec Function
• Delete a Codec Function

2024-09-13

This is the twenty-second official release.

Newly added:

• Create an IoTDA Instance
• This API is used to query the instance list.
• Query Instance Details
• Modify Instance Information
• Delete an Instance
• Modify Instance Specifications
• Change the Billing Mode of an Instance
• Adding an Instance Tag
• Delete an Instance Tag

2024-06-25

This issue is the twenty-first official release, which incorporates the following change:

Newly added:

• Create a Device Policy
• Query the Device Policy List
• Delete a Device Policy
• Query the Device Policy List
• Update Device Policy Information
• Bind a Device Policy
• Unbind a Device Policy
• Query the List of the Targets Bound to a Device Policy
• Create a Pre-provisioning Template
• Query the Pre-provisioning Template List
• Delete a Pre-provisioning Template
• Query Pre-provisioning Template Details
• Update Information About a Pre-provisioning Template with a Specified ID
• Create a Custom Authenticator
• Query the Custom Authenticator List
• Delete a Custom Authenticator
• Query Custom Authenticator Details
• Update a Custom Authenticator with a Specified ID

2024-05-30

This issue is the twentieth official release, which incorporates the following change:

Newly added:

• Create a Bridge
• Query the Bridge List
• Delete a Bridge
• Reset the Bridge Secret
• Update a CA Certificate
• Query the List of Device Groups to Which a Specified Device Is Added

2024-04-26

This issue is the nineteenth official release, which incorporates the following change:

Newly added:

• Create a Device Proxy
• Query Device Proxy List
• Query Device Proxy Details
• Modify a Device Proxy
• Delete a Device Proxy

2024-04-11

This issue is the eighteenth official release, which incorporates the following change:

Newly added:

• Create a Data Transfer Stacking Policy
• Query the Data Transfer Stacking Policy List
• Modify a Data Transfer Stacking Policy
• Query the Data Transfer Stacking Policy
• Delete a Data Transfer Stacking Policy
• Create a Data Forwarding Flow Control Policy
• Query a List of Data Forwarding Flow Control Policies
• Modify a Data Forwarding Flow Control Policy
• Query a Specified Data Forwarding Flow Control Policy
• Delete a Specified Data Forwarding Flow Control Policy

2024-03-29

This issue is the seventeenth official release, which incorporates the following change:

Newly added:

• Updating Resource Spaces

Modified:

• Added the task_mode parameter to support the gateway mode for software/firmware upgrade tasks, and the task_ext_info parameter to support additional extended information for batch tasks. Involved APIs: Creating a Batch Task, Querying the Batch Task List, and Querying a Batch Task.

2024-03-13

This issue is the sixteenth official release, which incorporates the following changes:

Modified:

Added return parameters: provision_enable determines whether the self-registration capability is enabled for the CA certificate; template_id indicates the ID of the associated template after the self-registration capability is enabled. Involved APIs: Uploading a Device CA Certificate and Obtaining the Device CA Certificate List.

2024-02-27

This issue is the fifteenth official release, which incorporates the following changes:

Modified:

Changed the message_content parameter in the ActionSmnForwarding to an optional parameter, changed the value range of the message_title parameter, and added the message_template_name parameter to provide the capability of selecting an SMN template. Involved APIs: Creating a Rule, Querying the Rule List, Modifying a Rule, and Querying a Rule.

2023-01-05

This issue is the fourteenth official release, which incorporates the following changes:

Modified:

• Added the force_disconnect parameter to specify whether to forcibly disconnect the northbound MQTT/AMQP connection when an access credential is generated. Involved API: Generating an Access Credential.

2023-12-06

This issue is the thirteen official release, which incorporates the following changes:

Modified:

• Added the secret_type parameter to set or update a sub secret of the device. Involved API: Resetting a Device Secret.
• Added the fingerprint_type parameter to set or update a sub fingerprint of the device. Involved API: Resetting a Device Fingerprint.
• Added response parameters secondary_secret and secondary_fingerprint to query a sub fingerprint or sub secret of a device. Involved APIs: Querying a Device, Creating a Device, and Modifying a Device.

2023-11-15

This issue is the twelfth official release, which incorporates the following changes:

Involved APIs: Creating a Rule Action, Modifying a Rule Action, and Querying the Rule Action List. Modified content:

• Modified the enumerated values of the mechanism parameter in the dms_kafka_forwarding structure, and added the security_protocol parameter to support complete Kafka security authentication.
• Added the signature_enable and token parameters to the http_forwarding structure to provide diversified security authentication capabilities for HTTP push.

2023-10-23

This issue is the eleventh official release, which incorporates the following changes:

Modified:

Added the input parameter product_name to support product name search. Involved API: Querying the Product List.

2023-07-21

This issue is the tenth official release, which incorporates the following changes:

Newly added:

• Deleting a Batch Task
• Creating a Device Tunnel
• Querying All Tunnels of a Device
• Querying Device Tunnels
• Disable a Device Tunnel
• Deleting a Device Tunnel

2023-06-17

This issue is the ninth official release, which incorporates the following changes:

Newly added:

• Retrying a Batch Task
• Stopping a Batch Task

Modified:

Added the response parameters error_code and error_msg of the abnormal device behavior during synchronization, for example, a response times out. Involved APIs: Synchronous Device Command and Modifying Device Properties.

2023-05-13

This issue is the eighth official release, which incorporates the following changes:

Modified:

Added the group_type and dynamic_group_rule parameters to support dynamic device groups. Involved APIs: Adding a Device Group, Modifying a Device Group, Querying the Device Group List, and Querying a Device Group.

2023-04-19

This issue is the seventh official release, which incorporates the following changes:

Newly added:

The API for Delivering Broadcast Messages

Modified:

Modified the task_type parameter and added the enumerated value updateDevices to support batch device update tasks. Involved APIs: Creating a Batch Task, Querying the Batch Task List, and Querying a Batch Task.

2023-03-29

This issue is the sixth official release, which incorporates the following changes:

Modified:

Added the device_linkage_status_condition parameter to support the device linkage rule condition of device status changes. Involved APIs: Creating a Rule, Modifying a Rule, Querying the Rule List, and Querying a Rule.

2023-02-24

This issue is the fifth official release, which incorporates the following changes:

Newly added:

• Creating an OTA Upgrade Package
• Querying the OTA Upgrade Package List
• Querying OTA Upgrade Package Details
• Deleting an OTA Upgrade Package

Modified:

Added the response parameters connection_status_update_time and active_time to query the connection status change time and activation time of a device. Involved API: Querying a Device.

2023-02-07

This issue is the fourth official release, which incorporates the following changes:

Modified:

Added the dms_rocketmq_forwarding, mrs_kafka_forwarding, roma_forwarding, and influxdb_forwarding parameters to support message transfer of RocketMQ, Kafka, ROMA, and InfluxDB. Involved APIs: Creating a Rule Action, Modifying a Rule Action, and Querying the Rule Action List.

2022-12-14

This issue is the third official release, which incorporates the following changes:

Newly added:

The API for Querying Device List Flexibly

Modified:

Added the enumerated value DEVICE_SIDE for the rule_type parameter to support linkage rules on the device. Involved APIs: Creating a Rule, Modifying a Rule, Querying the Rule List, and Querying a Rule.

2022-09-20

This issue is the second official release, which incorporates the following changes:

Added the properties parameter to support MQTT 5.0. Involved APIs: Delivering a Device Message and Querying Device Messages.

2022-06-30

This is the first official release.

API Reference on the Application Side

MQTT or MQTTS API Reference on the Device Side

HTTPS API Reference on the Device Side

Module AT Command Reference