Todos los productos
Search
Centro de documentos

IoT Platform:Lista de operaciones por función

Última actualización: Sep 03, 2026

A continuación se describen las operaciones de API disponibles en IoT Platform.

Productos

API

Descripción

CreateProduct

Crea un producto.

UpdateProduct

Modifica la información de un producto.

QueryProductList

Consulta productos.

QueryProduct

Consulta los detalles de un producto.

DeleteProduct

Elimina un producto.

CreateProductTags

Crea etiquetas de producto.

UpdateProductTags

Modifica las etiquetas de un producto.

DeleteProductTags

Elimina etiquetas de producto.

ListProductTags

Consulta todas las etiquetas de un producto.

ListProductByTags

Consulta productos por etiqueta.

UpdateProductFilterConfig

Modifica la regla de deduplicación para los mensajes de propiedad que envían los dispositivos de un producto.

ReleaseProduct

Publica un producto.

CancelReleaseProduct

Cancela la publicación de un producto.

Dispositivos

API

Descripción

RegisterDevice

Registra un dispositivo.

QueryClientIds

Consulta los ClientID de un dispositivo. Esta operación de API es compatible con la verificación de certificado único por producto sin preregistro.

TransformClientId

Especifica un ClientID válido para un dispositivo con el fin de evitar inicios de sesión no autorizados si el dispositivo tiene varios ClientID. Esta operación de API es compatible con la verificación de certificado único por producto sin preregistro.

DeleteClientIds

Elimina todos los ClientID de un dispositivo si la cantidad supera el límite (5). Esta operación de API es compatible con la verificación de certificado único por producto sin preregistro.

QueryDeviceInfo

Consulta la información básica de un dispositivo, incluido el ID del dispositivo, el certificado del dispositivo y el alias.

QueryDeviceDetail

Consulta los detalles de un dispositivo.

BatchQueryDeviceDetail

Consulta los detalles de varios dispositivos.

QueryDevice

Consulta los dispositivos de un producto.

DeleteDevice

Elimina un dispositivo.

GetDeviceStatus

Consulta el estado de un dispositivo.

BatchGetDeviceState

Consulta los estados de varios dispositivos.

DisableThing

Deshabilita un dispositivo.

EnableThing

Habilita un dispositivo deshabilitado.

ResetThing

Restablece un dispositivo.

BatchCheckDeviceNames

Especifica nombres para varios dispositivos simultáneamente. IoT Platform comprueba si los nombres son válidos.

BatchRegisterDeviceWithApplyId

Registra varios dispositivos simultáneamente mediante un ID de solicitud.

BatchRegisterDevice

Registra varios dispositivos simultáneamente.

QueryBatchRegisterDeviceStatus

Consulta el estado de procesamiento del registro de varios dispositivos.

QueryPageByApplyId

Consulta varios dispositivos por ID de solicitud.

SaveDeviceProp

Crea etiquetas para un dispositivo.

QueryDeviceProp

Consulta las etiquetas de un dispositivo.

DeleteDeviceProp

Elimina las etiquetas de un dispositivo.

GetThingTopo

Consulta los subdispositivos de un dispositivo de puerta de enlace.

NotifyAddThingTopo

Notifica a un dispositivo de puerta de enlace que establezca una relación topológica con un subdispositivo.

BatchAddThingTopo

Establece relaciones topológicas entre varios subdispositivos y un dispositivo de puerta de enlace.

RemoveThingTopo

Elimina las relaciones topológicas de un dispositivo.

QueryDeviceStatistics

Consulta estadísticas de dispositivos.

GetGatewayBySubDevice

Consulta la información de un dispositivo de puerta de enlace según la información del subdispositivo.

QueryDeviceByTags

Consulta dispositivos por etiqueta.

QueryDeviceFileList

Consulta los archivos que un dispositivo cargó en IoT Platform.

QueryDeviceFile

Consulta los detalles de un archivo que un dispositivo cargó en IoT Platform.

DeleteDeviceFile

Elimina un archivo que un dispositivo cargó en IoT Platform.

BatchUpdateDeviceNickname

Modifica los alias de varios dispositivos.

QueryDeviceByStatus

Consulta dispositivos por estado.

ListOTAModuleVersionsByDevice

Consulta las versiones del módulo de actualización inalámbrica (OTA) que notificaron los dispositivos.

ImportDevice

Agrega un dispositivo a un producto de puerta de enlace MQTT.

BatchImportDevice

Agrega varios dispositivos simultáneamente a un producto de puerta de enlace MQTT.

BatchCheckImportDevice

Verifica varios dispositivos agregados simultáneamente a un producto de puerta de enlace MQTT.

QueryImportedDeviceByApplyId

Consulta varios dispositivos agregados simultáneamente por ID de solicitud.

BatchImportVehicleDevice

Agrega varios dispositivos simultáneamente a un producto de puerta de enlace JT/T 808.

BatchCheckVehicleDevice

Verifica varios dispositivos agregados simultáneamente a un producto de puerta de enlace JT/T 808.

QueryVehicleDevice

Consulta la información de un dispositivo de un producto de puerta de enlace JT/T 808.

Distribución de dispositivos

API

Descripción

CreateDeviceDistributeJob

Crea una tarea para distribuir dispositivos. También se distribuye el producto al que pertenecen los dispositivos.

CreateProductDistributeJob

Crea una tarea para distribuir un producto a una instancia.

QueryDeviceDistributeDetail

Consulta el resultado de una tarea de distribución de dispositivos.

QueryDeviceDistributeJob

Consulta los detalles de una tarea de distribución de dispositivos.

ListDeviceDistributeJob

Consulta tareas de distribución de dispositivos.

DeleteDeviceDistributeJob

Elimina una tarea de distribución de dispositivos.

ListDistributedDevice

Consulta dispositivos distribuidos.

ListDistributedProduct

Consulta productos distribuidos.

Grupos de dispositivos

API

Descripción

CreateDeviceGroup

Crea un grupo de dispositivos.

DeleteDeviceGroup

Elimina un grupo de dispositivos.

UpdateDeviceGroup

Modifica la información de un grupo de dispositivos.

QueryDeviceGroupInfo

Consulta los detalles de un grupo de dispositivos.

QueryDeviceGroupList

Consulta todos los grupos de dispositivos.

BatchAddDeviceGroupRelations

Agrega dispositivos a un grupo de dispositivos.

BatchDeleteDeviceGroupRelations

Quita dispositivos de un grupo de dispositivos.

SetDeviceGroupTags

Crea etiquetas para un grupo de dispositivos o actualiza sus etiquetas existentes.

QueryDeviceGroupTagList

Consulta las etiquetas de un grupo de dispositivos.

QueryDeviceGroupByDevice

Consulta los grupos a los que pertenece un dispositivo.

QuerySuperDeviceGroup

Consulta los detalles de un grupo principal según el ID del subgrupo.

QueryDeviceListByDeviceGroup

Consulta los dispositivos de un grupo de dispositivos.

QueryDeviceGroupByTags

Consulta grupos de dispositivos por etiqueta.

Modelos de Thing Specification Language (TSL)

API

Descripción

CreateThingModel

Agrega funciones o información extendida al modelo TSL de un producto.

UpdateThingModel

Modifica una función o la información extendida del modelo TSL de un producto.

QueryThingModel

Consulta los detalles del modelo TSL de un producto.

CopyThingModel

Copia el modelo TSL de un producto a un producto de destino.

PublishThingModel

Publica el modelo TSL de un producto.

DeleteThingModel

Elimina una función del modelo TSL de un producto.

ListThingTemplates

Consulta todas las categorías de productos predefinidas en IoT Platform.

GetThingTemplate

Consulta la información del modelo TSL estándar de una categoría.

ListThingModelVersion

Consulta las versiones del modelo TSL de un producto.

GetThingModelTsl

Consulta el modelo TSL de un producto.

ImportThingModelTsl

Importa un modelo TSL a un producto. No es posible importar información extendida.

QueryThingModelPublished

Consulta los detalles de un modelo TSL publicado para un producto.

GetThingModelTslPublished

Consulta la información básica de un modelo TSL publicado para un producto.

QueryThingModelExtendConfig

Consulta la información extendida del modelo TSL de un producto.

QueryThingModelExtendConfigPublished

Consulta la información extendida de un modelo TSL publicado.

CreateThingScript

Envía un script de análisis de datos para un producto.

UpdateThingScript

Modifica un script de análisis de datos para un producto.

GetThingScript

Consulta un script de análisis de datos para un producto.

Uso de modelos TSL

API

Descripción

SetDeviceProperty

Configura las propiedades de un dispositivo.

SetDevicesProperty

Configura las propiedades de varios dispositivos simultáneamente.

InvokeThingService

Invoca un servicio en un dispositivo.

InvokeThingsService

Invoca un servicio en varios dispositivos simultáneamente.

QueryDevicePropertyData

Consulta los registros de propiedades de un dispositivo.

QueryDevicePropertiesData

Consulta los registros de varias propiedades de un dispositivo.

QueryDeviceEventData

Consulta los registros de eventos de un dispositivo.

QueryDeviceServiceData

Consulta los registros de servicios de un dispositivo.

SetDeviceDesiredProperty

Especifica varios valores de propiedades deseadas para un dispositivo simultáneamente.

QueryDeviceDesiredProperty

Consulta los valores de propiedades deseadas de un dispositivo.

QueryDevicePropertyStatus

Consulta las instantáneas de propiedades de un dispositivo.

QueryDeviceOriginalPropertyStatus

Consulta las instantáneas de propiedades originales de un dispositivo.

QueryDeviceOriginalPropertyData

Consulta los registros de propiedades originales de un dispositivo.

QueryDeviceOriginalEventData

Consulta los registros de eventos originales de un dispositivo.

QueryDeviceOriginalServiceData

Consulta los registros de servicios originales de un dispositivo.

ClearDeviceDesiredProperty

Elimina los valores deseados de las propiedades de un dispositivo.

Reenvío de datos (versión anterior)

API

Descripción

ListRule

Consulta reglas.

CreateRule

Crea una regla.

GetRule

Consulta los detalles de una regla.

UpdateRule

Modifica una regla.

DeleteRule

Elimina una regla.

ListDataSourceItem

Consulta los topics de un origen de datos en el motor de reglas.

ListRuleActions

Consulta acciones de regla.

GetRuleAction

Consulta los detalles de una acción de regla.

CreateRuleAction

Crea una acción de regla.

UpdateRuleAction

Modifica una acción de regla.

DeleteRuleAction

Elimina una acción de regla.

StartRule

Habilita una regla.

StopRule

Deshabilita una regla.

Reenvío de datos (versión nueva)

API

Descripción

CreateParser

Crea un analizador sintáctico.

UpdateParser

Actualiza el nombre y la descripción de un analizador sintáctico.

ListParser

Consulta los detalles de los analizadores sintácticos, incluyendo información básica, estado, fecha de creación y fecha de modificación.

GetParser

Consulta los detalles de un analizador sintáctico, incluyendo información básica, script de análisis, estado y origen de datos asociado.

DeleteParser

Elimina un analizador sintáctico.

CreateParserDataSource

Crea un origen de datos desde el cual se desea reenviar información.

UpdateParserDataSource

Actualiza el nombre y la descripción de un origen de datos.

ListParserDataSource

Consulta todos los orígenes de datos.

GetParserDataSource

Consulta los detalles de un origen de datos.

DeleteParserDataSource

Elimina un origen de datos.

CreateDataSourceItem

Agrega un topic a un origen de datos.

ListDataSourceItem

Consulta los topics de un origen de datos.

DeleteDataSourceItem

Desasocia un topic de un origen de datos.

CreateDestination

Crea un destino de datos hacia el cual se desea reenviar información.

UpdateDestination

Actualiza el nombre, el tipo y la descripción de un destino de datos.

ListDestination

Consulta destinos de datos.

GetDestination

Consulta los detalles de un destino de datos.

DeleteDestination

Elimina un destino de datos.

AttachParserDataSource

Asocia un analizador sintáctico con un origen de datos.

ListParserDestination

Consulta los destinos de datos asociados a un analizador sintáctico.

DetachParserDataSource

Desasocia un analizador sintáctico de un origen de datos.

AttachDestination

Asocia un analizador sintáctico con un destino de datos.

DetachDestination

Desasocia un analizador sintáctico de un destino de datos.

SaveScript

Modifica y guarda el borrador del script de un analizador sintáctico.

PublishScript

Publica el script de un analizador sintáctico.

StartParser

Habilita un analizador sintáctico.

StopParser

Deshabilita un analizador sintáctico.

Temas

API

Descripción

CreateProductTopic

Crea una categoría de Topic personalizado para un producto.

UpdateProductTopic

Modifica una categoría de Topic personalizado.

QueryProductTopic

Consulta las categorías de Topic personalizado de un producto.

DeleteProductTopic

Elimina una categoría de Topic personalizado.

CreateTopicRouteTable

Crea una tabla de rutas para un Topic.

QueryTopicRouteTable

Consulta la tabla de rutas de un Topic.

QueryTopicReverseRouteTable

Consulta la tabla de rutas inversas de un Topic.

DeleteTopicRouteTable

Elimina la tabla de rutas de un Topic.

Suscripción del lado del servidor

API

Descripción

CreateSubscribeRelation

Crea una suscripción del lado del servidor de Message Service (MNS) o Advanced Message Queuing Protocol (AMQP).

UpdateSubscribeRelation

Modifica una suscripción del lado del servidor de MNS o AMQP.

QuerySubscribeRelation

Consulta los detalles de una suscripción del lado del servidor de MNS o AMQP.

DeleteSubscribeRelation

Elimina una suscripción del lado del servidor de MNS o AMQP.

CreateConsumerGroup

Crea un grupo de consumidores para configurar una suscripción del lado del servidor de AMQP.

UpdateConsumerGroup

Cambia el nombre de un grupo de consumidores.

QueryConsumerGroupByGroupId

Consulta los detalles de un grupo de consumidores mediante su ID.

QueryConsumerGroupList

Consulta todos los grupos de consumidores de una cuenta o realiza una búsqueda aproximada por nombre.

QueryConsumerGroupStatus

Consulta el estado de un grupo de consumidores cuando está habilitada la suscripción del lado del servidor de AMQP. La información incluye clientes en línea, tasa de consumo de mensajes, cantidad de mensajes acumulados y la hora más reciente de consumo.

ResetConsumerGroupPosition

Borra los mensajes acumulados de un grupo de consumidores cuando está habilitada una suscripción del lado del servidor de AMQP.

DeleteConsumerGroup

Elimina un grupo de consumidores.

CreateConsumerGroupSubscribeRelation

Agrega un grupo de consumidores a una suscripción del lado del servidor de AMQP.

DeleteConsumerGroupSubscribeRelation

Elimina un grupo de consumidores de una suscripción del lado del servidor de AMQP.

Mensajería

API

Descripción

RRpc

Envía una solicitud a un dispositivo y recibe una respuesta de forma síncrona.

PubBroadcast

Difunde un mensaje a todos los dispositivos de un producto o a todos los dispositivos suscritos a un Topic.

Pub

Publica un mensaje en un dispositivo mediante un Topic personalizado. Esta operación permite difundir mensajes a dispositivos en línea suscritos al Topic personalizado que pertenecen a un producto específico.

BatchPub

Publica un mensaje en varios dispositivos de un producto mediante un Topic personalizado.

SubscribeTopic

Suscribe un Topic a un dispositivo.

QueryDeviceSubTopic

Consulta los Topics a los que está suscrito un dispositivo.

Sombras de dispositivo

API

Descripción

GetDeviceShadow

Consulta la información de sombra de un dispositivo.

UpdateDeviceShadow

Modifica la información de sombra de un dispositivo.

Actualizaciones OTA

API

Descripción

GenerateOTAUploadURL

Genera la URL y los detalles de un paquete de actualización para cargar en OSS.

GenerateDeviceNameListURL

Genera la URL y los detalles de un archivo de lista de dispositivos para cargar en OSS. Al crear un lote de actualización estático, este archivo permite especificar los dispositivos que se actualizarán.

CreateOTAFirmware

Agrega un paquete de actualización.

DeleteOTAFirmware

Elimina un paquete de actualización.

ListOTAFirmware

Consulta paquetes de actualización.

QueryOTAFirmware

Consulta los detalles de un paquete de actualización.

CreateOTAVerifyJob

Crea un lote de validación para un paquete de actualización.

CreateOTAStaticUpgradeJob

Crea un lote de actualización estático.

CreateOTADynamicUpgradeJob

Crea un lote de actualización dinámico.

ListOTAJobByFirmware

Consulta los lotes de actualización de un paquete.

ListOTAJobByDevice

Consulta los lotes de actualización de un paquete por dispositivo.

ListOTATaskByJob

Consulta las tareas de actualización de un dispositivo por lote.

QueryOTAJob

Consulta los detalles de un lote de actualización.

CancelOTAStrategyByJob

Cancela una directiva de actualización asociada a un lote de actualización dinámico.

CancelOTATaskByDevice

Cancela las tareas de actualización pendientes de un paquete.

CancelOTATaskByJob

Cancela las tareas de actualización de dispositivos de un lote.

CreateOTAModule

Crea un módulo OTA para un producto.

UpdateOTAModule

Modifica el alias y la descripción de un módulo OTA.

DeleteOTAModule

Elimina un módulo OTA personalizado.

ListOTAModuleByProduct

Consulta los módulos OTA de un producto.

ConfirmOTATask

Confirma las tareas de actualización de dispositivos que tienen estado pendiente de confirmación.

ListOTAUnfinishedTaskByDevice

Consulta las tareas de actualización incompletas de un dispositivo.