QueryDeviceServiceData - IoT Platform: Central de Documentação do Alibaba Cloud

Consulta os registros de chamada de serviço de um dispositivo especificado.

Observações de uso

É possível consultar apenas os registros de chamada de serviço dos últimos 30 dias.

Nota

O período de armazenamento de um registro de chamada de serviço é calculado a partir do dia da chamada.

Limites de QPS

Você pode chamar esta operação de API até 50 vezes por segundo por conta.

Nota

Os usuários RAM de uma conta Alibaba Cloud compartilham a cota da conta.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	QueryDeviceServiceData	A operação a ser executada. Defina o valor como QueryDeviceServiceData.
EndTime	Long	Sim	1579249499000	Fim do intervalo de tempo a ser consultado. O valor é um timestamp Unix. Unidade: milissegundos. Exemplo: 1579249499000.
StartTime	Long	Sim	1579249499000	Início do intervalo de tempo a ser consultado. O valor é um timestamp Unix. Unidade: milissegundos. Exemplo: 1579249499000.
IotInstanceId	String	Não	iot_instc_pu***_c-v64********	ID da instância. Visualize o ID da instância na página Overview no console IoT Platform. Importante Se sua instância possuir um ID, especifique-o neste parâmetro. Caso contrário, a chamada falhará. Se nenhuma página Overview ou ID for gerada para sua instância, não configure este parâmetro. Para mais informações, consulte Visão geral.
IotId	String	Não	Q7uOhVRdZRRlDnTLv****00100	ID do dispositivo. Identificador exclusivo emitido pelo IoT Platform para o dispositivo. Importante O parâmetro IotId especifica um GUID para o dispositivo. O valor do parâmetro IotId equivale à combinação dos valores dos parâmetros ProductKey e DeviceName. Ao especificar um valor para este parâmetro, não configure os parâmetros ProductKey ou DeviceName. Se forem especificados valores para os parâmetros IotId, ProductKey e DeviceName, o valor do parâmetro IotId terá precedência.
ProductKey	String	Não	a1BwAGV****	ProductKey do produto ao qual o dispositivo pertence. Importante Ao especificar um valor para este parâmetro, configure também o parâmetro DeviceName.
DeviceName	String	Não	light	DeviceName do dispositivo. Importante Ao especificar um valor para este parâmetro, configure também o parâmetro ProductKey.
Identifier	String	Não	Set	Identificador do serviço chamado. Visualize o identificador do serviço na aba Define Feature no console IoT Platform. Também é possível chamar a operação QueryThingModel para visualizar o identificador do serviço. Nota Se um serviço chamado testService pertencer a um módulo personalizado chamado testFb, defina este parâmetro como testFb:testService. O módulo personalizado não é o módulo padrão. Caso nenhum valor seja especificado para este parâmetro, o sistema consulta todos os dados de serviço do módulo padrão.
Asc	Integer	Não.	0	Ordem de classificação dos registros de chamada de serviço retornados. Valores válidos: 0: ordem cronológica inversa 1: ordem cronológica
PageSize	Integer	Não	10	Número de entradas a serem retornadas em cada página. Valores válidos: 1 a 50.

Além dos parâmetros de solicitação específicos da operação anteriores, configure os parâmetros de solicitação comuns ao chamar esta operação. Para mais informações sobre parâmetros de solicitação comuns, consulte Parâmetros comuns.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
Code	String	iot.system.SystemException	Código de erro retornado se a chamada falhar. Para mais informações, consulte Códigos de erro.
Data	Struct		Registros de chamada de serviço retornados se a chamada for bem-sucedida.
List	Array of ServiceInfo		Array de registros de chamada de serviço. Cada elemento representa um registro de chamada de serviço.
ServiceInfo
Identifier	String	Set	Identificador do serviço.
InputData	String	{\"LightAdjustLevel\":123}	Parâmetro de entrada do serviço. O valor é uma string no formato MAP. Sintaxe: `key:value`.
Name	String	Set_Temperature	Nome do serviço.
OutputData	String	{\"code\":200,\"data\":{},\"id\":\"100686\",\"message\":\"success\",\"version\":\"1.0\"}	Parâmetro de saída do serviço. O valor é uma string no formato MAP. Sintaxe: `key:value`.
Time	String	1579249499000	Momento em que o serviço foi chamado.
NextTime	Long	1579335899000	Hora inicial dos registros de chamada de serviço na próxima página. Ao chamar a operação QueryDeviceServiceData para consultar os registros de chamada de serviço na próxima página, defina o parâmetro StartTime com o valor deste parâmetro.
NextValid	Boolean	true	Indica se a próxima página existe. true false Se o valor retornado do parâmetro NextValid for true, utilize o valor do parâmetro NextTime como valor do parâmetro StartTime ao consultar a próxima página de resultados.
ErrorMessage	String	A system exception occurred.	Mensagem de erro retornada se a chamada falhar.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	ID da solicitação. Identifica a solicitação de forma exclusiva.
Success	Boolean	true	Indica se a chamada foi bem-sucedida. Valores válidos: true: A chamada foi bem-sucedida. false: A chamada falhou.

Exemplos

Exemplos de solicitações

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceServiceData
&ProductKey=a1BwAGV****
&DeviceName=device1
&Identifier=set
&StartTime=1516538300303
&EndTime=1516541900303
&PageSize=10
&Asc=1
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

<QueryDeviceServiceDataResponse>
  <Data>
        <NextValid>true</NextValid>
        <NextTime>1517315865197</NextTime>
        <List>
              <ServiceInfo>
                    <Name>set</Name>
                    <Time>1517315865198</Time>
                    <OutputData>{"code":200,"data":{},"id":"100686","message":"success","version":"1.0"}</OutputData>
                    <InputData>{"LightAdjustLevel":123}</InputData>
                    <Identifier>set</Identifier>
              </ServiceInfo>
        </List>
  </Data>
  <RequestId>A44C818E-FA7F-4765-B1E7-01D14AE01C6A</RequestId>
  <Success>true</Success>
</QueryDeviceServiceDataResponse>

Formato JSON

{
  "Data": {
    "NextValid": true, 
    "NextTime": 1517315865197, 
    "List": {
      "ServiceInfo": [
        {
          "Name": "set", 
          "Time": 1517315865198, 
          "OutputData": "{\"code\":200,\"data\":{},\"id\":\"100686\",\"message\":\"success\",\"version\":\"1.0\"}", 
          "InputData": "{\"LightAdjustLevel\":123}", 
          "Identifier": "set"
        }
      ]
    }
  }, 
  "RequestId": "A44C818E-FA7F-4765-B1E7-01D14AE01C6A", 
  "Success": true
}

Códigos de erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.