A continuación se describen las operaciones de API disponibles en IoT Platform.
Productos
|
API |
Descripción |
|
Crea un producto. |
|
|
Modifica la información de un producto. |
|
|
Consulta productos. |
|
|
Consulta los detalles de un producto. |
|
|
Elimina un producto. |
|
|
Crea etiquetas de producto. |
|
|
Modifica las etiquetas de un producto. |
|
|
Elimina etiquetas de producto. |
|
|
Consulta todas las etiquetas de un producto. |
|
|
Consulta productos por etiqueta. |
|
|
Modifica la regla de deduplicación para los mensajes de propiedad que envían los dispositivos de un producto. |
|
|
Publica un producto. |
|
|
Cancela la publicación de un producto. |
Dispositivos
|
API |
Descripción |
|
Registra un dispositivo. |
|
|
Consulta los ClientID de un dispositivo. Esta operación de API es compatible con la verificación de certificado único por producto sin preregistro. |
|
|
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. |
|
|
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. |
|
|
Consulta la información básica de un dispositivo, incluido el ID del dispositivo, el certificado del dispositivo y el alias. |
|
|
Consulta los detalles de un dispositivo. |
|
|
Consulta los detalles de varios dispositivos. |
|
|
Consulta los dispositivos de un producto. |
|
|
Elimina un dispositivo. |
|
|
Consulta el estado de un dispositivo. |
|
|
Consulta los estados de varios dispositivos. |
|
|
Deshabilita un dispositivo. |
|
|
Habilita un dispositivo deshabilitado. |
|
|
Restablece un dispositivo. |
|
|
Especifica nombres para varios dispositivos simultáneamente. IoT Platform comprueba si los nombres son válidos. |
|
|
Registra varios dispositivos simultáneamente mediante un ID de solicitud. |
|
|
Registra varios dispositivos simultáneamente. |
|
|
Consulta el estado de procesamiento del registro de varios dispositivos. |
|
|
Consulta varios dispositivos por ID de solicitud. |
|
|
Crea etiquetas para un dispositivo. |
|
|
Consulta las etiquetas de un dispositivo. |
|
|
Elimina las etiquetas de un dispositivo. |
|
|
Consulta los subdispositivos de un dispositivo de puerta de enlace. |
|
|
Notifica a un dispositivo de puerta de enlace que establezca una relación topológica con un subdispositivo. |
|
|
Establece relaciones topológicas entre varios subdispositivos y un dispositivo de puerta de enlace. |
|
|
Elimina las relaciones topológicas de un dispositivo. |
|
|
Consulta estadísticas de dispositivos. |
|
|
Consulta la información de un dispositivo de puerta de enlace según la información del subdispositivo. |
|
|
Consulta dispositivos por etiqueta. |
|
|
Consulta los archivos que un dispositivo cargó en IoT Platform. |
|
|
Consulta los detalles de un archivo que un dispositivo cargó en IoT Platform. |
|
|
Elimina un archivo que un dispositivo cargó en IoT Platform. |
|
|
Modifica los alias de varios dispositivos. |
|
|
Consulta dispositivos por estado. |
|
|
Consulta las versiones del módulo de actualización inalámbrica (OTA) que notificaron los dispositivos. |
|
|
Agrega un dispositivo a un producto de puerta de enlace MQTT. |
|
|
Agrega varios dispositivos simultáneamente a un producto de puerta de enlace MQTT. |
|
|
Verifica varios dispositivos agregados simultáneamente a un producto de puerta de enlace MQTT. |
|
|
Consulta varios dispositivos agregados simultáneamente por ID de solicitud. |
|
|
Agrega varios dispositivos simultáneamente a un producto de puerta de enlace JT/T 808. |
|
|
Verifica varios dispositivos agregados simultáneamente a un producto de puerta de enlace JT/T 808. |
|
|
Consulta la información de un dispositivo de un producto de puerta de enlace JT/T 808. |
Distribución de dispositivos
|
API |
Descripción |
|
Crea una tarea para distribuir dispositivos. También se distribuye el producto al que pertenecen los dispositivos. |
|
|
Crea una tarea para distribuir un producto a una instancia. |
|
|
Consulta el resultado de una tarea de distribución de dispositivos. |
|
|
Consulta los detalles de una tarea de distribución de dispositivos. |
|
|
Consulta tareas de distribución de dispositivos. |
|
|
Elimina una tarea de distribución de dispositivos. |
|
|
Consulta dispositivos distribuidos. |
|
|
Consulta productos distribuidos. |
Grupos de dispositivos
|
API |
Descripción |
|
Crea un grupo de dispositivos. |
|
|
Elimina un grupo de dispositivos. |
|
|
Modifica la información de un grupo de dispositivos. |
|
|
Consulta los detalles de un grupo de dispositivos. |
|
|
Consulta todos los grupos de dispositivos. |
|
|
Agrega dispositivos a un grupo de dispositivos. |
|
|
Quita dispositivos de un grupo de dispositivos. |
|
|
Crea etiquetas para un grupo de dispositivos o actualiza sus etiquetas existentes. |
|
|
Consulta las etiquetas de un grupo de dispositivos. |
|
|
Consulta los grupos a los que pertenece un dispositivo. |
|
|
Consulta los detalles de un grupo principal según el ID del subgrupo. |
|
|
Consulta los dispositivos de un grupo de dispositivos. |
|
|
Consulta grupos de dispositivos por etiqueta. |
Modelos de Thing Specification Language (TSL)
|
API |
Descripción |
|
Agrega funciones o información extendida al modelo TSL de un producto. |
|
|
Modifica una función o la información extendida del modelo TSL de un producto. |
|
|
Consulta los detalles del modelo TSL de un producto. |
|
|
Copia el modelo TSL de un producto a un producto de destino. |
|
|
Publica el modelo TSL de un producto. |
|
|
Elimina una función del modelo TSL de un producto. |
|
|
Consulta todas las categorías de productos predefinidas en IoT Platform. |
|
|
Consulta la información del modelo TSL estándar de una categoría. |
|
|
Consulta las versiones del modelo TSL de un producto. |
|
|
Consulta el modelo TSL de un producto. |
|
|
Importa un modelo TSL a un producto. No es posible importar información extendida. |
|
|
Consulta los detalles de un modelo TSL publicado para un producto. |
|
|
Consulta la información básica de un modelo TSL publicado para un producto. |
|
|
Consulta la información extendida del modelo TSL de un producto. |
|
|
Consulta la información extendida de un modelo TSL publicado. |
|
|
Envía un script de análisis de datos para un producto. |
|
|
Modifica un script de análisis de datos para un producto. |
|
|
Consulta un script de análisis de datos para un producto. |
Uso de modelos TSL
|
API |
Descripción |
|
Configura las propiedades de un dispositivo. |
|
|
Configura las propiedades de varios dispositivos simultáneamente. |
|
|
Invoca un servicio en un dispositivo. |
|
|
Invoca un servicio en varios dispositivos simultáneamente. |
|
|
Consulta los registros de propiedades de un dispositivo. |
|
|
Consulta los registros de varias propiedades de un dispositivo. |
|
|
Consulta los registros de eventos de un dispositivo. |
|
|
Consulta los registros de servicios de un dispositivo. |
|
|
Especifica varios valores de propiedades deseadas para un dispositivo simultáneamente. |
|
|
Consulta los valores de propiedades deseadas de un dispositivo. |
|
|
Consulta las instantáneas de propiedades de un dispositivo. |
|
|
Consulta las instantáneas de propiedades originales de un dispositivo. |
|
|
Consulta los registros de propiedades originales de un dispositivo. |
|
|
Consulta los registros de eventos originales de un dispositivo. |
|
|
Consulta los registros de servicios originales de un dispositivo. |
|
|
Elimina los valores deseados de las propiedades de un dispositivo. |
Reenvío de datos (versión anterior)
|
API |
Descripción |
|
Consulta reglas. |
|
|
Crea una regla. |
|
|
Consulta los detalles de una regla. |
|
|
Modifica una regla. |
|
|
Elimina una regla. |
|
|
Consulta los topics de un origen de datos en el motor de reglas. |
|
|
Consulta acciones de regla. |
|
|
Consulta los detalles de una acción de regla. |
|
|
Crea una acción de regla. |
|
|
Modifica una acción de regla. |
|
|
Elimina una acción de regla. |
|
|
Habilita una regla. |
|
|
Deshabilita una regla. |
Reenvío de datos (versión nueva)
|
API |
Descripción |
|
Crea un analizador sintáctico. |
|
|
Actualiza el nombre y la descripción de un analizador sintáctico. |
|
|
Consulta los detalles de los analizadores sintácticos, incluyendo información básica, estado, fecha de creación y fecha de modificación. |
|
|
Consulta los detalles de un analizador sintáctico, incluyendo información básica, script de análisis, estado y origen de datos asociado. |
|
|
Elimina un analizador sintáctico. |
|
|
Crea un origen de datos desde el cual se desea reenviar información. |
|
|
Actualiza el nombre y la descripción de un origen de datos. |
|
|
Consulta todos los orígenes de datos. |
|
|
Consulta los detalles de un origen de datos. |
|
|
Elimina un origen de datos. |
|
|
Agrega un topic a un origen de datos. |
|
|
Consulta los topics de un origen de datos. |
|
|
Desasocia un topic de un origen de datos. |
|
|
Crea un destino de datos hacia el cual se desea reenviar información. |
|
|
Actualiza el nombre, el tipo y la descripción de un destino de datos. |
|
|
Consulta destinos de datos. |
|
|
Consulta los detalles de un destino de datos. |
|
|
Elimina un destino de datos. |
|
|
Asocia un analizador sintáctico con un origen de datos. |
|
|
Consulta los destinos de datos asociados a un analizador sintáctico. |
|
|
Desasocia un analizador sintáctico de un origen de datos. |
|
|
Asocia un analizador sintáctico con un destino de datos. |
|
|
Desasocia un analizador sintáctico de un destino de datos. |
|
|
Modifica y guarda el borrador del script de un analizador sintáctico. |
|
|
Publica el script de un analizador sintáctico. |
|
|
Habilita un analizador sintáctico. |
|
|
Deshabilita un analizador sintáctico. |
Temas
|
API |
Descripción |
|
Crea una categoría de Topic personalizado para un producto. |
|
|
Modifica una categoría de Topic personalizado. |
|
|
Consulta las categorías de Topic personalizado de un producto. |
|
|
Elimina una categoría de Topic personalizado. |
|
|
Crea una tabla de rutas para un Topic. |
|
|
Consulta la tabla de rutas de un Topic. |
|
|
Consulta la tabla de rutas inversas de un Topic. |
|
|
Elimina la tabla de rutas de un Topic. |
Suscripción del lado del servidor
|
API |
Descripción |
|
Crea una suscripción del lado del servidor de Message Service (MNS) o Advanced Message Queuing Protocol (AMQP). |
|
|
Modifica una suscripción del lado del servidor de MNS o AMQP. |
|
|
Consulta los detalles de una suscripción del lado del servidor de MNS o AMQP. |
|
|
Elimina una suscripción del lado del servidor de MNS o AMQP. |
|
|
Crea un grupo de consumidores para configurar una suscripción del lado del servidor de AMQP. |
|
|
Cambia el nombre de un grupo de consumidores. |
|
|
Consulta los detalles de un grupo de consumidores mediante su ID. |
|
|
Consulta todos los grupos de consumidores de una cuenta o realiza una búsqueda aproximada por nombre. |
|
|
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. |
|
|
Borra los mensajes acumulados de un grupo de consumidores cuando está habilitada una suscripción del lado del servidor de AMQP. |
|
|
Elimina un grupo de consumidores. |
|
|
Agrega un grupo de consumidores a una suscripción del lado del servidor de AMQP. |
|
|
Elimina un grupo de consumidores de una suscripción del lado del servidor de AMQP. |
Mensajería
|
API |
Descripción |
|
Envía una solicitud a un dispositivo y recibe una respuesta de forma síncrona. |
|
|
Difunde un mensaje a todos los dispositivos de un producto o a todos los dispositivos suscritos a un Topic. |
|
|
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. |
|
|
Publica un mensaje en varios dispositivos de un producto mediante un Topic personalizado. |
|
|
Suscribe un Topic a un dispositivo. |
|
|
Consulta los Topics a los que está suscrito un dispositivo. |
Sombras de dispositivo
|
API |
Descripción |
|
Consulta la información de sombra de un dispositivo. |
|
|
Modifica la información de sombra de un dispositivo. |
Actualizaciones OTA
|
API |
Descripción |
|
Genera la URL y los detalles de un paquete de actualización para cargar en OSS. |
|
|
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. |
|
|
Agrega un paquete de actualización. |
|
|
Elimina un paquete de actualización. |
|
|
Consulta paquetes de actualización. |
|
|
Consulta los detalles de un paquete de actualización. |
|
|
Crea un lote de validación para un paquete de actualización. |
|
|
Crea un lote de actualización estático. |
|
|
Crea un lote de actualización dinámico. |
|
|
Consulta los lotes de actualización de un paquete. |
|
|
Consulta los lotes de actualización de un paquete por dispositivo. |
|
|
Consulta las tareas de actualización de un dispositivo por lote. |
|
|
Consulta los detalles de un lote de actualización. |
|
|
Cancela una directiva de actualización asociada a un lote de actualización dinámico. |
|
|
Cancela las tareas de actualización pendientes de un paquete. |
|
|
Cancela las tareas de actualización de dispositivos de un lote. |
|
|
Crea un módulo OTA para un producto. |
|
|
Modifica el alias y la descripción de un módulo OTA. |
|
|
Elimina un módulo OTA personalizado. |
|
|
Consulta los módulos OTA de un producto. |
|
|
Confirma las tareas de actualización de dispositivos que tienen estado pendiente de confirmación. |
|
|
Consulta las tareas de actualización incompletas de un dispositivo. |