Este tópico descreve o gerenciamento e a utilização da API de métricas predefinidas, da API de dados do produto e da API de serviço personalizado.
Pré-requisitos
-
Para gerenciar e usar a API de métricas predefinidas, verifique se os produtos e dispositivos foram criados e se os backups estão concluídos.
Para mais informações, consulte acesso a dados.
Para utilizar a API de dados do produto ou a API de serviço personalizado, confirme que a API correspondente já foi criada. Para mais detalhes, consulte API de dados do produto e API de serviço personalizado.
Gerencie uma API
No IoT Platform console, acesse a página Overview e clique em ID ou no alias da instância Enterprise Edition desejada.
No painel de navegação à esquerda, escolha Data Service > Data API.
Na página Data API, selecione a aba Predefined Metrics API, Product Data API ou Custom Service API, localize a API desejada e clique em View na coluna Operation.
-
No canto superior direito da página API Details, escolha o número da versão para visualizar seus detalhes, incluindo informações básicas, monitoramento da API e parâmetros.
Clique em API Operations para revisar o uso da API.
Clique em API Test para testar a API e visualizar detalhes da solicitação, exemplos de retorno e exemplos de invocação.
Usar uma API
Com os detalhes da API disponíveis, integre e invoque a API correspondente em seu servidor para recuperar dados relevantes e aproveitar ao máximo seus ativos de dados.
Observe que o limite máximo de solicitações por segundo (QPS) para invocar a API de serviço de dados com uma única conta Alibaba Cloud é 100.
Invoque ListAnalyticsData para buscar dados da API especificada conforme os requisitos do negócio.
-
Caso utilize o SDK fornecido pela Alibaba Cloud, consulte os exemplos abaixo de acordo com sua linguagem de desenvolvimento:
-
Se não estiver usando o SDK da Alibaba Cloud, atente-se aos seguintes parâmetros comuns durante o desenvolvimento:
Nome
Tipo
Obrigatório
Valor de exemplo
Descrição
apiPath
String
Sim
pk/temperatureMax
Caminho do endpoint da API.
iotInstanceId
String
Sim
iot-cn-npk1u
Identificador exclusivo da instância do IoT Platform associada ao tópico. Para mais informações, consulte Problemas relacionados à instância do IoT Platform.
pageNum
Integer
Não (Condicional)
10
Número da página para resultados paginados.
pageSize
Integer
Não (Condicional)
100
Define a quantidade de registros por página, com limite máximo de 100.
-
Na página de detalhes da API, é possível revisar os parâmetros de retorno. A seguir, listamos os parâmetros de retorno mais comuns:
Nome
Tipo
Valor de exemplo
Descrição
Count
Long
3
Indica o número total de entradas retornadas.
HasNext
Boolean
false
Especifica se há páginas subsequentes de dados disponíveis.
true: Existe uma próxima página.
false: Não existem mais páginas.
PageNum
Integer
1
Número da página atual.
PageSize
Integer
100
Quantidade de entradas exibidas 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"}]
String JSON contendo os detalhes dos dados retornados.