Este tema describe la gestión y el uso de la API de métricas predefinidas, la API de datos de producto y la API de servicio personalizado.
Requisitos previos
-
Para gestionar y usar la API de métricas predefinidas, asegúrese de que los productos y dispositivos estén creados y de que las copias de seguridad se hayan completado.
Para obtener más información, consulte data access.
Para la API de datos de producto o la API de servicio personalizado, asegúrese de que la API correspondiente esté creada. Para obtener más información, consulte product data API y custom service API.
Gestionar una API
En la consola de IoT Platform, vaya a la página Overview y haga clic en el ID o alias de la instancia Enterprise Edition deseada.
En el panel de navegación izquierdo, seleccione Data Service > Data API.
Vaya a la página Data API, seleccione la pestaña Predefined Metrics API, Product Data API o Custom Service API, localice la API deseada y haga clic en View en la columna Operation.
-
En la parte superior derecha de la página API Details, elija el número de versión para consultar los detalles de dicha versión, incluida la información básica, el monitoreo de la API y los parámetros.
Haga clic en API Operations para revisar el uso de la API.
Haga clic en API Test para probar la API y ver los detalles de la solicitud, ejemplos de respuesta y ejemplos de invocación.
Uso de una API
Con los detalles de la API disponibles, integre e invoque la API correspondiente en su servidor para recuperar los datos relevantes y aprovechar al máximo sus activos de datos.
Tenga en cuenta que el límite de solicitudes por segundo (QPS) para invocar la API del servicio de datos con una sola cuenta de Alibaba Cloud es 100.
Invoque ListAnalyticsData para obtener datos de la API especificada según los requisitos del negocio.
-
Si usa el SDK proporcionado por Alibaba Cloud, consulte los siguientes ejemplos según su lenguaje de desarrollo:
-
Si no usa el SDK de Alibaba Cloud, considere los siguientes parámetros comunes durante el desarrollo:
Nombre
Tipo
Obligatorio
Valor de ejemplo
Descripción
apiPath
String
Sí
pk/temperatureMax
La ruta del endpoint de la API.
iotInstanceId
String
Sí
iot-cn-npk1u
El identificador único de la instancia de IoT Platform a la que está asociado el tema. Para obtener más información, consulte IoT Platform Instance Related Issues.
pageNum
Integer
No (condicional)
10
El número de página para resultados paginados.
pageSize
Integer
No (condicional)
100
Especifica el número de registros por página, hasta un máximo de 100.
-
En la página de detalles de la API, revise los parámetros de respuesta. A continuación se muestran los parámetros de retorno comunes:
Nombre
Tipo
Valor de ejemplo
Descripción
Count
Long
3
Indica el número total de entradas devueltas.
HasNext
Boolean
false
Especifica si hay páginas de datos adicionales disponibles.
true: Existe una página siguiente.
false: No hay más páginas.
PageNum
Integer
1
El número de página actual.
PageSize
Integer
100
El número de entradas mostradas por página.
ResultJson
String
[{"testCode":"TBB186","testLevel":5,"testWorkYears":3,"testName":"Jack"},{"testCode":"TBB1314","testLevel":2,"testWorkYears":4,"testName":"Tom"},{"testCode":"TBB8888","testLevel":2,"testWorkYears":5,"testName":"Eric"}]
Una cadena JSON que contiene los detalles de los datos devueltos.