IoT Platform:API de servicio personalizada

Requisitos previos

Debe haber creado métricas y tablas de almacenamiento para sus orígenes de datos. Para obtener más información, consulte Descripción general de métricas y Tablas de almacenamiento personalizadas.

1. En la IoT Platform console, vaya a la página Overview y haga clic en el ID o alias de la instancia Enterprise Edition deseada.

2. En el panel de navegación izquierdo, seleccione Data Service > Data API.

3. En la página Data API, haga clic en la pestaña custom service API y luego en Create API.

4. En el asistente Create API, configure los ajustes de la sección API basic information y haga clic en Next.

   Parámetro	Descripción
   Nombre de la API	Introduzca un nombre para la API. El nombre puede contener caracteres chinos, letras, dígitos, guiones bajos (_) y guiones (-), con una longitud máxima de 30 caracteres.
   Ruta de la API	Introduzca la ruta de la API. Esta funciona como identificador único de recurso dentro de la instancia. Al invocar la API, el valor del parámetro de solicitud apiPath debe coincidir con esta ruta. La ruta debe comenzar con una barra diagonal (/) y puede contener letras, dígitos, guiones bajos (_) y barras diagonales (/). La longitud máxima es de 128 caracteres. Por ejemplo: /pk/temperatureMax. Importante No es posible modificar la ruta de la API después de publicarla.
   Etiqueta de la API	Introduzca el contenido de la etiqueta y presione Enter. Una etiqueta puede contener caracteres chinos, letras, dígitos, guiones bajos (_) y guiones (-), con una longitud máxima de 30 caracteres. Use etiquetas como identificadores personalizados para facilitar la gestión de sus API. Importante Puede agregar un máximo de cinco etiquetas a una API.
   Descripción de la API	Introduzca una descripción para la API, como su propósito y capacidades.
   Formato de respuesta	El formato de los datos de respuesta es fijo en JSON.

5. En la página Configure and test parameters, complete los siguientes ajustes.

   Categoría	Parámetro	Descripción
   Origen de datos	Métrica	Seleccione un metric field y un dataset específicos. Un dataset es una organización específica de objetos dentro de un campo de métrica, como un producto concreto en el campo de productos o un dispositivo específico en el campo de dispositivos. Para obtener más información sobre las métricas, consulte ¿Qué es una métrica?.
   	Tabla de almacenamiento	Seleccione una tabla de almacenamiento personalizada generada por una tarea de análisis de datos o de SQL. Para obtener más información, consulte Tabla de almacenamiento en frío.
   Configurar parámetros	Conjunto de datos	Este ajuste solo aparece después de seleccionar Metric como data source y especificar un metric field y un dataset. Haga clic en Preview Data para ir a la página de detalles del origen de datos seleccionado.
   	Alcance de los datos	Este ajuste se muestra únicamente si selecciona Metric como data source. Seleccione el alcance de los datos para la API: derived metric: Datos obtenidos de métricas sin procesar, definiciones originales y definiciones derivadas mediante cálculos agregados como suma y promedio. derived definition: Métrica derivada de una definición original y aplicada a subentidades. Para obtener más información sobre métricas y definiciones derivadas, consulte Tipos de métricas.
   	Parámetros de solicitud	Haga clic en Add Parameter para agregar métricas del origen de datos seleccionado como parámetros de solicitud de la API. Solo se admiten campos del sistema y campos de clave principal de una tabla de almacenamiento personalizada. Para cada parámetro, configure su campo vinculado, nombre, tipo, operador, si es obligatorio, un valor de ejemplo y una descripción. Importante Si el tipo de parámetro es numérico, no se admite el operador LIKE.
   	Parámetros de respuesta	Haga clic en Add Parameter para agregar métricas del origen de datos seleccionado como parámetros de respuesta de la API. Para cada parámetro, configure su prioridad, campo vinculado, nombre, tipo, si se usa para ordenamiento, un valor de ejemplo y una descripción. Seleccione la casilla Select All Parameters a la derecha para incluir todos los campos de la tabla en la respuesta de la API. Nota Ordena los resultados por este campo en orden ascendente o descendente. Cada métrica solo puede configurarse como un único parámetro de respuesta.
   	Orden de clasificación	Seleccione el orden en el que se clasificarán los parámetros. Ascending (predeterminado): Los parámetros se ordenan de forma ascendente. Descending: Los parámetros se ordenan de forma descendente.
   Configuración avanzada	Habilitar respuesta paginada	Especifica si se habilita la paginación para la respuesta. Disabled: Devuelve un máximo de 100 resultados. Enabled: Devuelve todos los resultados en páginas. Si habilita esta función, se agregan automáticamente los siguientes parámetros comunes: pageNum: Número de página. pageSize: Tamaño de página. El valor máximo es 100.
   	Configuración de error de tiempo de espera	Si una llamada a la API supera los 8 segundos, se devuelve un error de tiempo de espera. Este ajuste no se puede modificar.

   Una vez completados estos ajustes, introduzca valores de prueba para los parámetros de solicitud en la sección Test API y haga clic en Start Test.

   Consulte los datos de muestra en la pestaña Response Example o haga clic en Request Details para ver la información específica de la solicitud. Si la prueba se realiza correctamente, la pestaña Response Example muestra la respuesta JSON, incluidos campos como errCode:0 y errMsg:"success". En la parte inferior aparecen un mensaje de Test succeeded y la duración de la llamada a la API.

6. Haga clic en Publish.

   Importante

   • Antes de publicar una API, asegúrese de que pase la prueba.

   • Si solo hace clic en Save, la API se guarda con estado sin conexión.

   • Para una API con configuraciones incompletas, haga clic en Edit para completar la configuración y luego publicarla.

   • Solo puede eliminar API sin conexión.

   En la página Published successfully, haga clic en Create Another para crear más API personalizadas, o en View in List para consultar la API en la lista.

Siguientes pasos

Después de crear una API de servicio personalizada, puede invocarla para recuperar datos. Para obtener instrucciones, consulte Gestionar y usar API.

Para consultar ejemplos de llamadas, consulte:

• Ejemplo de llamada de SDK de Java

• Ejemplo de llamada de SDK de Node.js