CLI Command Reference(IoTDA)

Query the Product List

hcloud IoTDA ListProducts

This API is used by an application to query the list of product models that have been imported to the platform.

Go debug

Create a Product

hcloud IoTDA CreateProduct

This API is used by an application to create a product. This API is used to create a product but not to create or install a codec. If you need to encode or decode data, develop and install a codec on the platform.

Go debug

Query a Product

hcloud IoTDA ShowProduct

This API is used by an application to query details of a product model that has been imported to the IoT platform, including the services, properties, and commands in the product model.

Go debug

Modify a Product

hcloud IoTDA UpdateProduct

This API is used by an application to modify details of a product model that has been imported to the IoT platform, including the services, properties, and commands in the product model. This API is used to modify the product but not to modify or install a codec. If the service definition in the product is modified and the corresponding codec exists on the platform, modify and reinstall the codec.

Go debug

Delete a Product

hcloud IoTDA DeleteProduct

This API is used by an application to delete a specific product model that has been imported to the IoT platform. This API can delete only the product but not the associated codec. If the product has devices, the product cannot be deleted.

Go debug

Query the Device List

hcloud IoTDA ListDevices

This API is used by an application to query the device list on the IoT platform.

Go debug

Create a Device

hcloud IoTDA AddDevice

This API is used by an application to create a device on the IoT platform. Only the created device can connect to the IoT platform.

Go debug

Query a Device

hcloud IoTDA ShowDevice

This API is used by an application to query the details of a specific device on the IoT platform.

Go debug

Modify a Device

hcloud IoTDA UpdateDevice

This API is used by an application to modify the basic information of a specific device on the IoT platform.

Go debug

Delete a Device

hcloud IoTDA DeleteDevice

This API is used by an application to delete a specific device from the IoT platform. If the device is connected to an indirectly connected device, you must delete the indirectly connected device first. This API can be used to delete a single device. For details about how to delete devices in batches, see Creating a Batch Task.

Go debug

Reset a Device Secret

hcloud IoTDA ResetDeviceSecret

This API is used by an application to reset a device secret. If the request contains a secret, the platform resets the device secret to the specified secret. If the request does not contain a secret, the platform automatically generates a new random secret and returns it.

Go debug

Freeze a Device

hcloud IoTDA FreezeDevice

This API is used by an application to freeze a device. After a device is frozen, it cannot connect to the platform. You can use the API "Unfreezing a Device" to unfreeze the device. Currently, only devices that are directly connected to the platform can be frozen. This API can be used to freeze a single device. For details about how to freeze devices in batches, see Creating a Batch Task.

Go debug

Unfreeze a Device

hcloud IoTDA UnfreezeDevice

This API is used by an application to unfreeze a device. After the device is unfrozen, the device can connect to the platform and go online. This API can be used to unfreeze a single device. For details about how to unfreeze devices in batches, see Creating a Batch Task.

Go debug

Reset a Device Fingerprint

hcloud IoTDA ResetFingerprint

This API is used by an application to reset a device fingerprint. A device fingerprint will be reset to the specified one. If a device fingerprint is not specified, it is set to the certificate fingerprint used when the device is connected to the platform for the first time.

Go debug

Modify a Device Gateway

hcloud IoTDA ChangeGateway

This API is used by an application to modify a child device gateway in the IoT platform.

Go debug

Query Device List Flexibly

hcloud IoTDA SearchDevices

This API is used by an application to query a desired device list using SQL statements.

Go debug

Query the List of Device Groups to Which a Specified Device Is Added

hcloud IoTDA ListDeviceGroupsByDevice

This API is used by an application to query the list of device groups to which a device in the IoT platform is added. This API is supported only by standard and enterprise editions.

Go debug

Query Device Messages

hcloud IoTDA ListDeviceMessages

This API is used by an application to query messages delivered by the platform to a device. By default, the platform stores up to 20 messages for each device. If the number of messages exceeds 20, the earliest messages will be overwritten by subsequent messages.

Go debug

Deliver a Message to a Device

hcloud IoTDA CreateMessage

This API is used by an application to deliver a message to a device. After an application delivers a message to the platform, the platform returns a response to the application and then sends the message to the device. The response returned by the platform may not be the device receiving result. Call the API Pushing a Device Message Status Change Notification for the platform to push the device receiving result to the application.

Go debug

Query a Message by Message ID

hcloud IoTDA ShowDeviceMessage

This API is used by an application to query a message with a specified ID delivered by the platform to a device.

Go debug

Delete a Message by Message ID

hcloud IoTDA DeleteDeviceMessage

This API is used by an application to delete a message with a specified ID delivered by the platform to a device.

Go debug

Deliver a Command to a Device

hcloud IoTDA CreateCommand

A product model defines commands that the IoT platform can deliver to devices. An application can call this API to deliver commands to a specific device to control the device synchronously. The platform synchronously sends commands to the device and returns the command execution result to the application. If the device does not respond, the platform returns a timeout message to the application. The timeout interval is 20 seconds. If the command delivery takes more than 20 seconds, use the API Delivering a Message to a Device.

Go debug

Deliver an Asynchronous Command

hcloud IoTDA CreateAsyncCommand

A product model defines commands that the IoT platform can deliver to devices. An application can call this API to deliver asynchronous commands to a specific device to control the device. The platform delivers commands to the device and asynchronously returns the command execution result to the application. The command execution result supports data forwarding. After the application calls the API for creating a rule triggering condition (resource is set to device.command.status and event to update) and the API for creating a rule action and activates a rule, the platform pushes the result to the server specified by the rule when the command status changes. The server can be a user-defined HTTP server, AMQP server, or Huawei Cloud storage server. For details, see Pushing a Device Command Status Change Notification.

Go debug

Query a Command in the Queue of a Device

hcloud IoTDA ListAsyncCommands

Queries a command (in processing) in the queue of a device. The command status can be PENDING, SENT, or DELIVERED. Note that if a command in the DELIVERED status is not updated after a specified period of time (depending on the system configuration), the command will be removed from the queue and changed to a historical command.

Go debug

Query a Historical Device Command

hcloud IoTDA ListAsyncHistoryCommands

Queries historical asynchronous commands delivered by devices. Status: EXPIRED, SUCCESSFUL, FAILED, TIMEOUT, or DELIVERED.

Go debug

Collects Statistics on the Total Number of Historical Commands of a Device

hcloud IoTDA CountAsyncHistoryCommands

Collects statistics on the total number of historical commands of a device.

Go debug

Query a Command with a Specific ID

hcloud IoTDA ShowAsyncDeviceCommand

This API is used to query a command with a specific ID.

Go debug

Query Device Properties

hcloud IoTDA ListProperties

A product model defines properties that the platform can deliver to devices. This API is used by an application to query real-time properties of a device. The device returns the query result to the application.

Go debug

Modify Device Properties

hcloud IoTDA UpdateProperties

A product model defines properties that the platform can deliver to devices. This API is used by an application to deliver properties to a specific device. The platform sends the properties to the device in synchronous mode and returns the execution result synchronously to the application.

Go debug

Query the AMQP List

hcloud IoTDA BatchShowQueue

This API is used by an application to query the Advanced Message Queuing Protocol (AMQP) list on the IoT platform. Fuzzy query can be performed based on the queue name. Results can be displayed in separate pages.

Go debug

Create an AMQP Queue

hcloud IoTDA AddQueue

This API is used by an application to create an AMQP queue on the IoT platform. Each tenant can create up to 100 queues. If the number of queues exceeds 100 or the name of a queue to create is the same as an existing queue name, the creation fails.

Go debug

Query an AMQP Queue

hcloud IoTDA ShowQueue

This API is used by an application to query the details of a specific queue on the IoT platform.

Go debug

Delete an AMQP Queue

hcloud IoTDA DeleteQueue

This API is used by an application to delete a specific AMQP queue from the IoT platform. If the queue is in use, the deletion fails.

Go debug

Generate an Access Credential

hcloud IoTDA CreateAccessCode

This API is used by a client to generate an access credential, so the client can use the credential to connect to the platform through a protocol such as AMQP. Only one record is retained. If the API is called again, the access credential is reset and the previous one becomes invalid.

Go debug

Query the Rule Triggering Condition List

hcloud IoTDA ListRoutingRules

This API is used by an application to query the rule triggering condition list on the IoT platform.

Go debug

Create a Rule Triggering Condition

hcloud IoTDA CreateRoutingRule

This API is used by an application to create a rule triggering condition on the IoT platform.

Go debug

Query a Rule Triggering Condition

hcloud IoTDA ShowRoutingRule

This API is used by an application to query the configuration of a specific rule triggering condition on the IoT platform.

Go debug

Modify a Rule Triggering Condition

hcloud IoTDA UpdateRoutingRule

This API is used by an application to modify the configuration of a specific rule triggering condition on the IoT platform.

Go debug

Delete a Rule Triggering Condition

hcloud IoTDA DeleteRoutingRule

This API is used by an application to delete a specific rule triggering condition from the IoT platform.

Go debug

Query the Rule Action List

hcloud IoTDA ListRuleActions

This API is used by an application to query the rule action list on the IoT platform.

Go debug

Create a Rule Action

hcloud IoTDA CreateRuleAction

This API is used by an application to create a rule action on the IoT platform.

Go debug

Query a Rule Action

hcloud IoTDA ShowRuleAction

This API is used by an application to query the configuration of a specific rule action on the IoT platform.

Go debug

Modify a Rule Action

hcloud IoTDA UpdateRuleAction

This API is used by an application to modify the configuration of a specific rule action on the IoT platform.

Go debug

Delete a Rule Action

hcloud IoTDA DeleteRuleAction

This API is used by an application to delete a specific rule action from the IoT platform.

Go debug

Create a Data Transfer Stacking Policy

hcloud IoTDA CreateRoutingBacklogPolicy

This API is used by an application to create a data transfer and stacking policy in the IoT platform.

Go debug

Query the Data Transfer Stacking Policy List

hcloud IoTDA ListRoutingBacklogPolicy

This API is used by an application to query the list of data transfer and stacking policies configured on the IoT platform.

Go debug

Modify a Data Transfer Stacking Policy

hcloud IoTDA UpdateRoutingBacklogPolicy

This API is used by an application to modify a specified data transfer and stacking policy on the IoT platform.

Go debug

Query the Data Transfer Stacking Policy

hcloud IoTDA ShowRoutingBacklogPolicy

This API is used by an application to query a specified data transfer and stacking policy on the IoT platform.

Go debug

Delete a Data Transfer Stacking Policy

hcloud IoTDA DeleteRoutingBacklogPolicy

This API is used by an application to delete a specified data transfer and stacking policy from the IoT platform.

Go debug

Create a Data Forwarding Flow Control Policy

hcloud IoTDA CreateRoutingFlowControlPolicy

This API is used by an application to create a data forwarding flow control policy on the IoT platform.

Go debug

Query a List of Data Forwarding Flow Control Policies

hcloud IoTDA ListRoutingFlowControlPolicy

This API is used by an application to query a list of data forwarding flow control policies configured on the IoT platform.

Go debug

Modify a Data Forwarding Flow Control Policy

hcloud IoTDA UpdateRoutingFlowControlPolicy

This API is used by an application to modify a specified data forwarding flow control policy on the IoT platform.

Go debug

Query a Specified Data Forwarding Flow Control Policy

hcloud IoTDA ShowRoutingFlowControlPolicy

This API is used by an application to query a specified data forwarding flow control policy on the IoT platform.

Go debug

Delete a Specified Data Forwarding Flow Control Policy

hcloud IoTDA DeleteRoutingFlowControlPolicy

This API is used by an application to delete a specified data forwarding flow control policy from the IoT platform.

Go debug

Query the Rule List

hcloud IoTDA ListRules

This API is used by an application to query the rule list on the platform.

Go debug

Creating a Rule

hcloud IoTDA CreateRule

This API is used by an application to create a rule on the IoT platform.

Go debug

Query a Rule

hcloud IoTDA ShowRule

This API is used by an application to query the configuration of a specific rule on the platform.

Go debug

Modify a Rule

hcloud IoTDA UpdateRule

This API is used by an application to modify the configuration of a specific rule on the platform.

Go debug

Delete a Rule

hcloud IoTDA DeleteRule

This API is used by an application to delete a specific rule from the IoT platform.

Go debug

Modify the Rule Status

hcloud IoTDA ChangeRuleStatus

This API is used by an application to modify the status of a specific rule on the platform to activate or deactivate the rule.

Go debug

Query a Device Shadow

hcloud IoTDA ShowDeviceShadow

This API is used by an application to query the device shadow of a specific device, including the desired device properties (in the desired section) and the latest properties reported by the device (in the reported section).

Go debug

Configure Desired Properties in a Device Shadow

hcloud IoTDA UpdateDeviceShadowDesiredData

This API is used by an application to configure properties in the desired section of a device shadow. When the device goes online or reports properties, the desired properties are delivered to the device.

Go debug

Delete Device Shadow

hcloud IoTDA DeleteDeviceShadow

This API is used by an application to delete the device shadow of a specific device, including the desired device properties (in the desired section) and the latest properties reported by the device (in the reported section).

Go debug

Query the Device Group List

hcloud IoTDA ListDeviceGroups

This API is used by an application to query the device group list on the IoT platform.

Go debug

Create a Device Group

hcloud IoTDA AddDeviceGroup

This API is used by an application to create a device group. Up to 1000 device groups, including parent device groups and child device groups, can be created in a Huawei Cloud account. The maximum number of group levels is five. It means that the relationship tree of groups can have up to five levels.

Go debug

Query a Device Group

hcloud IoTDA ShowDeviceGroup

This API is used by an application to query details about a specific device group.

Go debug

Modify a Device Group

hcloud IoTDA UpdateDeviceGroup

This API is used by an application to modify a specific device group on the platform.

Go debug

Delete a Device Group

hcloud IoTDA DeleteDeviceGroup

This API is used by an application to delete a specific device group. If the device group contains child device groups or devices, the child device groups need to be deleted or the devices need to be removed from the device group first.

Go debug

Manage Devices in a Device Group

hcloud IoTDA CreateOrDeleteDeviceInGroup

This API is used by an application to manage devices in a device group. Up to 20,000 devices can be added to a device group. A device can be added to up to 10 device groups.

Go debug

Query Devices in a Device Group

hcloud IoTDA ShowDevicesInGroup

This API is used by an application to query the list of devices in a specific group.

Go debug

Bind Tags

hcloud IoTDA TagDevice

This API is used by an application to bind tags to a specific resource. Currently, only devices can be tagged.

Go debug

Unbind Tags

hcloud IoTDA UntagDevice

This API is used by an application to unbind tags from a specific resource. Currently, only devices can be tagged.

Go debug

Query Resources by Tag

hcloud IoTDA ListResourcesByTags

This API is used by an application to query resources with specific tags. Currently, only devices can be tagged.

Go debug

Query the Resource Space List

hcloud IoTDA ShowApplications

The resource space corresponds to the original application of the platform. The meaning of the resource space in the platform is the same as that of the application. The only difference lies in the name. This API is used by an application to query the resource space list.

Go debug

Create a Resource Space

hcloud IoTDA AddApplication

The resource space corresponds to the original application of the platform. The meaning of the resource space in the platform is the same as that of the application. The only difference lies in the name. This API is used by an application to create a resource space.

Go debug

Query a Resource Space

hcloud IoTDA ShowApplication

The resource space corresponds to the original application of the platform. The meaning of the resource space in the platform is the same as that of the application. The only difference lies in the name. This API is used by an application to query details about a specific resource space.

Go debug

Delete a Resource Space

hcloud IoTDA DeleteApplication

This API is used to delete a specific resource space. Deleting a resource space is a high-risk operation. After the resource space is deleted, resources such as products and devices in the space will be unavailable. Exercise caution when performing this operation.

Go debug

Update Resource Spaces

hcloud IoTDA UpdateApplication

This API is used by an application to update the name of a resource space.

Go debug

Query the Batch Task List

hcloud IoTDA ListBatchTasks

This API is used by an application to query the batch task list on the IoT platform. Each task includes the task content, task status, and task completion statistics.

Go debug

Create a Batch Task

hcloud IoTDA CreateBatchTask

This API is used by an application to create a batch task to perform batch operations on multiple devices. You can upgrade software and firmware, create, delete, freeze, and unfreeze devices, and create command tasks in batches.

Go debug

Query a Batch Task

hcloud IoTDA ShowBatchTask

This API is used by an application to query a specific batch task on the platform, including the task content, task status, task completion statistics, and subtask list.

Go debug

Delete a Batch Task

hcloud IoTDA DeleteBatchTask

This API is used by an application to delete a completed batch task (successful, failed, partially successful, or stopped) from the platform.

Go debug

Re-Execute a Batch Task

hcloud IoTDA RetryBatchTask

This API is used by an application server to retry a batch task. Currently, task_type can only be set to firmwareUpgrade or softwareUpgrade. If the task specified by task_id is successful, stopped, being stopped, waiting, or being initialized, this API cannot be called. If the request body is {}, all subtasks in the Fail, FailWaitRetry, and Stopped statuses will be re-executed after this API is called.

Go debug

Stop a Batch Task

hcloud IoTDA StopBatchTask

This API is used by an application server to stop a batch task. Currently, task_type can only be set to firmwareUpgrade or softwareUpgrade. If the task specified by task_id has been completed (successful, failed, partially successful, or stopped) or is being stopped, this API cannot be called. If the request body is {}, all subtasks in the Processing, Waitting, and FailWaitRetry statuses will be stopped after this API is called.

Go debug

Confirm the Execution of a Batch Task

hcloud IoTDA ConfirmBatchTask

This API is used by an application to confirm the execution of a batch task. This parameter is supported when task_type is set to firmwareUpgrade, softwareUpgrade, or moduleUpgrade. This API cannot be called if the task identified by task_id has been completed (successful, failed, partially successful, or stopped) or is being stopped. If the request body is {}, all subtasks in the waiting state will be confirmed for execution after this API is called.

Go debug

Query the List of Batch Task Files

hcloud IoTDA ListBatchTaskFiles

This API is used by an application to query the batch task file list.

Go debug

Upload a Batch Task File

hcloud IoTDA UploadBatchTaskFile

This API is used by an application to upload a batch task file for task creation. You can upload files of batch device creation, deletion, freezing, and unfreezing tasks.

Go debug

Delete a Batch Task File

hcloud IoTDA DeleteBatchTaskFile

This API is used by an application to delete a batch task file.

Go debug

Obtain the Device CA Certificate List

hcloud IoTDA ListCertificates

This API is used by an application to obtain the device CA certificate list from the IoT platform.

Go debug

Upload a Device CA Certificate

hcloud IoTDA AddCertificate

This API is used by an application to upload a device CA certificate to the IoT platform.

Go debug

Update a CA Certificate

hcloud IoTDA UpdateCertificate

This API is used by an application to update a CA certificate on the IoT platform. This API is supported only by standard and enterprise editions.

Go debug

Delete a Device CA Certificate

hcloud IoTDA DeleteCertificate

This API is used by an application to delete a device CA certificate from the IoT platform.

Go debug

Query a CA Certificate

hcloud IoTDA ShowCertificate

This API is used by an application to query a CA certificate on the IoT platform.

Go debug

Verify a Device CA Certificate

hcloud IoTDA CheckCertificate

This API is used by an application to verify a device CA certificate on the IoT platform to check whether the user has the private key of the CA certificate.

Go debug

Create a Device Tunnel

hcloud IoTDA AddTunnel

API for creating a device tunnel.

Go debug

Query All Tunnels of a Device

hcloud IoTDA ListDeviceTunnels

Users can use this API to query the data of all device tunnels in a project for device management. This API is used by an application to query the status of device tunnels from the IoT platform.

Go debug

Query Device Tunnels

hcloud IoTDA ShowDeviceTunnel

Users can use this API to query the information and connection status of a device tunnel in a project. This API is used by an application to query the status of a device tunnel from the IoT platform.

Go debug

Disable a Device Tunnel

hcloud IoTDA CloseDeviceTunnel

API for disabling a device tunnel.

Go debug

Delete a Device Tunnel

hcloud IoTDA DeleteDeviceTunnel

API for deleting a device tunnel.

Go debug

Query Device Proxy List

hcloud IoTDA ListDeviceProxies

This API is used by an application to query the device proxy list on the IoT platform.

Go debug

Create a Device Proxy

hcloud IoTDA CreateDeviceProxy

This API is used by an application to create a dynamic device proxy rule on the IoT platform for a child device to select a gateway to go online and report messages. That is, a child device under any gateway in the proxy group can go online through other devices in the proxy group. For details, see Gateway Updating Child Device Status) and Gateway Reporting Device Properties in Batches).

Go debug

Query Device Proxy Details

hcloud IoTDA ShowDeviceProxy

This API is used by an application to query the details of a specific device proxy on the IoT platform.

Go debug

Modify a Device Proxy

hcloud IoTDA UpdateDeviceProxy

This API is used by an application to modify the basic information of a specific device proxy on the IoT platform.

Go debug

Delete a Device Proxy

hcloud IoTDA DeleteDeviceProxy

This API is used by an application to delete a specific device proxy from the IoT platform.

Go debug

Query the Bridge List

hcloud IoTDA ListBridges

This API is used by an application to query the bridge list on the IoT platform.

Go debug

Create a Bridge

hcloud IoTDA AddBridge

This API is used by an application to create a bridge on the IoT platform. Only the created bridge can connect to the platform.

Go debug

Delete a Bridge

hcloud IoTDA DeleteBridge

This API is used by an application to delete a specific bridge from the IoT platform.

Go debug

Reset the Bridge Secret

hcloud IoTDA ResetBridgeSecret

This API is used by an application to reset the bridge secret on the IoT platform.

Go debug

Query a Codec Function

hcloud IoTDA ListFunctions

Provides the function of querying codec functions.

Go debug

Create a Codec Function

hcloud IoTDA AddFunctions

Provides the function of creating codec functions.

Go debug

Delete a Codec Function

hcloud IoTDA DeleteFunctions

Provides the function of deleting codec functions.

Go debug

Create an Export Task

hcloud IoTDA CreateExportTask

This API is used by an application to create a resource export task.

Go debug

Query Export Task List

hcloud IoTDA ListExportTasks

This API is used by an application to query the list of created export tasks.

Go debug

Delete an Export Task

hcloud IoTDA DeleteExportTask

This API is used by an application to delete an export task created on the platform.

Go debug

Download an Exported File

hcloud IoTDA ShowExportTask

This API is used by an application to download the files generated by a completed export task.

Go debug

Query the HarmonyOS Soft Bus List

hcloud IoTDA ListHarmonySoftBus

This API is used by an application to query the HarmonyOS soft bus list.

Go debug

Create a HarmonyOS Soft Bus

hcloud IoTDA AddHarmonySoftBus

This API is used by an application to create a HarmonyOS soft bus.

Go debug

Query the HarmonyOS Soft Bus

hcloud IoTDA ShowHarmonySoftBus

This API is used by an application to query a HarmonyOS soft bus by ID.

Go debug

Delete a HarmonyOS Soft Bus

hcloud IoTDA DeleteHarmonySoftBus

This API is used by an application to delete a specified HarmonyOS soft bus.

Go debug

Synchronize the HarmonyOS Soft Bus

hcloud IoTDA CreateSyncHarmonySoftBus

This API is used by an application to synchronize HarmonyOS soft bus information to devices in the group.

Go debug

Reset the Key of a HarmonyOS Soft Bus

hcloud IoTDA ResetHarmonySoftBusKey

This API is used by an application to reset the HarmonyOS soft bus key. After the key is reset, the status changes to unsynchronized. You need to call the API to synchronize the latest key to the devices in the group.

Go debug

Query Security Situation Awareness Configurations

hcloud IoTDA ListSecurityProfiles

This API is used by an application to query the list of security situation awareness configurations.

Go debug

Create or Update Security Situation Awareness Configuration

hcloud IoTDA CreateSecurityProfile

This API is used by an application to create a security situation awareness configuration.

Go debug

Query the Details About the Security Situation Awareness Configuration of a Specific ID

hcloud IoTDA ShowSecurityProfile

This API is used by an application to query the details about the security situation awareness configuration of a specific ID.

Go debug

Update the Security Situation Awareness Configuration Information of a Specific ID

hcloud IoTDA UpdateSecurityProfile

This API is used by an application to update the security situation awareness configuration of a specific ID.

Go debug

Delete the Security Situation Awareness Configuration of a Specific ID

hcloud IoTDA DeleteSecurityProfile

This API is used by an application to delete the security situation awareness configuration of a specific ID.

Go debug

Query the Device Authentication Template List

hcloud IoTDA ListDeviceAuthenticationTemplates

This API is used by an application to query the device authentication template list on IoT platform.

Go debug

Create a Device Authentication Template

hcloud IoTDA CreateDeviceAuthenticationTemplate

This API is used by an application to create a device authentication template on the IoT platform.

Go debug

Query Details About an Authentication Template

hcloud IoTDA ShowDeviceAuthenticationTemplate

The API is used by an application to query details about a device authentication template with a specified ID on the IoT platform.

Go debug

Modify the Device Authentication Template

hcloud IoTDA UpdateDeviceAuthenticationTemplate

This API is used by an application to modify a device authentication template on the IoT platform.

Go debug

Delete a Device Authentication Template

hcloud IoTDA DeleteDeviceAuthenticationTemplate

This API is used by an application to delete a device authentication template from the IoT platform.

Go debug

Query Device Certificate List

hcloud IoTDA ListDeviceCertificate

This API is used by an application to query the device certificate list in the IoT platform.

Go debug

Query a Device Certificate

hcloud IoTDA ShowDeviceCertificate

This API is used by an application to update the status of a device certificate on the IoT platform.

Go debug

Update a Device Certificate

hcloud IoTDA UpdateDeviceCertificate

This API is used by an application to update the status of a device certificate on the IoT platform.

Go debug

Delete a Device Certificate

hcloud IoTDA DeleteDeviceCertificate

This API is used by an application to delete a device certificate from the IoT platform.

Go debug

Query the List of Devices that Use a Specified Device Certificate

hcloud IoTDA ListDeviceByDeviceCertificate

This API is used by an application to query the list of devices that use a specified device certificate on the IoT platform.

Go debug

Create an OTA Module

hcloud IoTDA CreateOtaModule

This API is used to create an OTA module for a product. Max. 10 custom OTA modules for a product.

Go debug

Query the OTA Module List

hcloud IoTDA ListOtaModules

This API is used to query the OTA module list of a specified product.

Go debug

Query OTA Module Details

hcloud IoTDA ShowOtaModule

This API is used to query the details of an OTA module.

Go debug

Delete an OTA Module

hcloud IoTDA DeleteOtaModule

This API is used to delete an OTA module.

Go debug

Modify an OTA Module

hcloud IoTDA UpdateOtaModule

This API is used to modify the alias and description of an OTA module.

Go debug

Add Domain Configurations

hcloud IoTDA CreateDomainConfiguration

This API is used by an application to add a domain configuration (one at most) to the platform.

Go debug

Obtain the Domain Configuration List

hcloud IoTDA ListDomainConfigurations

This API is used by an application to obtain the domain configuration list on the platform.

Go debug

Delete Domain Configurations

hcloud IoTDA DeleteDomainConfiguration

This API is used by an application to delete domain configurations from the platform.

Go debug

Query Domain Configurations

hcloud IoTDA ShowDomainConfiguration

This API is used by an application to query domain configurations on the platform.

Go debug

Update Domain Configurations

hcloud IoTDA UpdateDomainConfiguration

This API is used by an application to update domain configurations on the platform.

Go debug

Add a Server Certificate

hcloud IoTDA CreateServerCertificate

This API is used by an application to add a server certificate to the platform. The server certificate quota is 2.

Go debug

Obtain the Server Certificate List

hcloud IoTDA ListServerCertificate

This API is used by an application to obtain the server certificate list on the platform.

Go debug

Delete a Server Certificate

hcloud IoTDA DeleteServerCertificate

This API is used by an application to delete a server certificate from the platform.

Go debug

Query the Server Certificate

hcloud IoTDA ShowServerCertificate

This API is used by an application to query a server certificate on the platform.

Go debug

Create Generic-Protocol Configuration

hcloud IoTDA CreateProtocolConfig

Provides the function to create a Generic-Protocol configuration, which is only supported by the enterprise edition whitelist.

Go debug

Query Generic-Protocol Configuration List

hcloud IoTDA ListProtocolConfigs

Provides the function to query the list of Generic-Protocol configurations, which is only supported by the enterprise edition whitelist.

Go debug

Delete Generic-Protocol Configuration

hcloud IoTDA DeleteProtocolConfig

Provides the function to delete a Generic-Protocol configuration, which is only supported by the enterprise edition whitelist.

Go debug

Query Generic-Protocol Configuration Details

hcloud IoTDA ShowProtocolConfig

Provides the function to query Generic-Protocol configuration details, which is only supported by the enterprise edition whitelist.

Go debug

Update Generic-Protocol Configuration

hcloud IoTDA UpdateProtocolConfig

Provides the function to update a Generic-Protocol configuration, which is only supported by the enterprise edition whitelist.

Go debug

Broadcasting a Message

hcloud IoTDA BroadcastMessage

This API is used by an application to broadcast a message to all online devices that subscribe to a specified topic. After an application delivers a broadcast message to the platform, the platform returns a response to the application and then broadcasts the message to devices.

Go debug

Query the Pre-provisioning Template List

hcloud IoTDA ListProvisioningTemplates

This API is used by an application to query a pre-provisioning template list on the IoT platform.

Go debug

Create a Pre-provisioning Template

hcloud IoTDA CreateProvisioningTemplate

This API is used by an application to create a pre-provisioning template on the IoT platform. For a device not registered, you can use a pre-provisioning template to automatically register the device information on the IoT platform when the device connects to the platform for the first time.

Go debug

Query Pre-provisioning Template Details

hcloud IoTDA ShowProvisioningTemplate

This API is used by an application to query details about a pre-provisioning template with a specified ID on the IoT platform.

Go debug

Update Information About a Pre-provisioning Template with a Specified ID

hcloud IoTDA UpdateProvisioningTemplate

This API is used by an application to update a pre-provisioning template with a specified ID on the IoT platform.

Go debug

Delete a Pre-provisioning Template

hcloud IoTDA DeleteProvisioningTemplate

This API is used by an application to delete a specified pre-provisioning template from the IoT platform.

Go debug

Query the Custom Authenticator List

hcloud IoTDA ListDeviceAuthorizers

This API is used by an application to query the custom authenticator list on the IoT platform.

Go debug

Create a Custom Authenticator

hcloud IoTDA CreateDeviceAuthorizer

This API is used by an application to create a custom authenticator on the IoT platform. You can use function services to customize the logic to authenticate devices connected to the platform.

Go debug

Query Custom Authenticator Details

hcloud IoTDA ShowDeviceAuthorizer

This API is used by an application to query details about a custom authenticator with a specified ID on the IoT platform.

Go debug

Update a Custom Authenticator with a Specified ID

hcloud IoTDA UpdateDeviceAuthorizer

This API is used by an application to update a custom authenticator with a specified ID on the IoT platform.

Go debug

Delete a Custom Authenticator

hcloud IoTDA DeleteDeviceAuthorizer

This API is used by an application to delete a specified custom authenticator from the IoT platform.

Go debug

Query the Device Policy List

hcloud IoTDA ListDevicePolicies

This API is used by an application to query the policy list on the IoT platform.

Go debug

Create a Device Policy

hcloud IoTDA CreateDevicePolicy

This API is used by an application to create a policy on the IoT platform. The policy takes effect only after being bound to a device or product.

Go debug

Query Device Policy Details

hcloud IoTDA ShowDevicePolicy

This API is used by an application to query details about a specified policy ID on the IoT platform.

Go debug

Update Device Policy Information

hcloud IoTDA UpdateDevicePolicy

This API is used by an application to update a policy on the IoT platform.

Go debug

Delete a Device Policy

hcloud IoTDA DeleteDevicePolicy

This API is used by an application to delete a specified policy from the IoT platform. Note that deleting a policy will unbind all objects bound to the policy.

Go debug

Bind a Device Policy

hcloud IoTDA BindDevicePolicy

This API is used by an application to bind a policy to devices in batches on the IoT platform. Currently, the target type can be device or product. When the target type is product, the policy takes effect on all devices under the product.

Go debug

Unbind a Device Policy

hcloud IoTDA UnbindDevicePolicy

This API is used by an application to unbind a target object from a specified policy on the IoT platform.

Go debug

Query the List of the Targets Bound to a Device Policy

hcloud IoTDA ShowTargetsInDevicePolicy

This API is used by an application to query the list of the targets bound to a specified policy ID on the IoT platform.

Go debug

Query the OTA Upgrade Package List

hcloud IoTDA ListOtaPackageInfo

This API is used to query upgrade packages associated with OBS objects.

Go debug

Create an OTA Upgrade Package

hcloud IoTDA CreateOtaPackage

This API is used to create an OBS object associated with an upgrade package.

Go debug

Obtain OTA Upgrade Package Details

hcloud IoTDA ShowOtaPackage

This API is used to query details about an upgrade package associated with an OBS object.

Go debug

Delete an OTA Upgrade Package

hcloud IoTDA DeleteOtaPackage

This API is used to delete the upgrade package information associated with an OBS object. The OBS object will not be deleted.

Go debug