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

Consulta informações sobre todos os arquivos enviados de um dispositivo para o IoT Platform.

Limites

As informações de arquivo retornadas nesta chamada não contêm URLs de download. Para obter a URL de download de um arquivo, chame a operação QueryDeviceFile.
Cada conta Alibaba Cloud pode executar no máximo 500 consultas por segundo (QPS).

Nota
Usuários RAM de uma conta Alibaba Cloud compartilham a cota dessa conta.

Depuração

O Alibaba Cloud oferece o OpenAPI Explorer para simplificar o uso de APIs. O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	QueryDeviceFileList	Operação a ser executada. Defina o valor como QueryDeviceFileList.
IotInstanceId	String	Não	iot_instc_pu***_c-v64********	ID da instância. Visualize o ID da instância na página Overview do console do IoT Platform. Importante Se a instância tiver um ID, configure este parâmetro. Caso contrário, a chamada falhará. Se a instância não tiver uma página Overview ou ID, não é necessário definir este parâmetro. Para mais informações, consulte Visão geral.
PageSize	Integer	Não	10	Número de entradas a retornar em cada página. Valor máximo: 200. Valor padrão: 10.
ProductKey	String	Não	a1BwAGV****	ProductKey do produto ao qual o dispositivo pertence. Nota Ao especificar este parâmetro, especifique também o parâmetro DeviceName.
DeviceName	String	Não	light	DeviceName do dispositivo. Nota Ao especificar este parâmetro, especifique também o parâmetro ProductKey.
IotId	String	Não	Q7uOhVRdZRRlDnTLv****00100	ID do dispositivo emitido pelo IoT Platform. Nota Se você especificar este parâmetro, não será necessário informar ProductKey ou DeviceName. O parâmetro IotId define um identificador globalmente único (GUID) do dispositivo, correspondente à combinação de ProductKey e DeviceName. Caso sejam informados tanto o IotId quanto a combinação de ProductKey e DeviceName, o IotId terá precedência.
CurrentPage	Integer	Não	1	Número da página a retornar. A numeração começa em 1. Valor padrão: 1.

Além dos parâmetros específicos da operação listados acima, especifique os parâmetros comuns de solicitação ao chamar esta operação. Para mais detalhes, consulte Parâmetros comuns de solicitação.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
Code	String	iot.system.SystemException	Código de erro retornado caso a chamada falhe. Para mais informações, consulte Códigos de erro.
CurrentPage	Integer	1	Número da página retornada.
Data	Array of FileSummary		Lista de arquivos retornada em caso de sucesso na chamada.
FileSummary
FileId	String	xL0G67MBLBDtkR7GCfT******	ID exclusivo do arquivo.
Name	String	testFile2.txt	Nome do arquivo.
Size	String	1024000	Tamanho do arquivo. Unidade: KB.
UtcCreatedOn	String	2019-03-21T08:45:42.000Z	Data e hora de criação do arquivo.
ErrorMessage	String	A system exception occurred.	Mensagem de erro retornada se a chamada falhar.
PageCount	Integer	1	Número total de páginas.
PageSize	Integer	10	Número de entradas retornadas por página.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	ID da solicitação.
Success	Boolean	true	Indica se a chamada foi bem-sucedida. true: A chamada foi bem-sucedida. false: A chamada falhou.
Total	Integer	2	Número total de arquivos.

Exemplos

Exemplos de solicitações

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceFileList
&ProductKey=a1BwAGV****
&DeviceName=deviceName1
&PageSize=10
&CurrentPage=1
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

<QueryDeviceFileListResponse>
  <PageCount>1</PageCount>
  <Data>
        <FileStoreSummary>
              <Name>testFile2.txt</Name>
              <FileId>xL0G67MBLBDtkR7GCfT******</FileId>
              <UtcCreatedOn>2019-03-21T08:45:42.000Z</UtcCreatedOn>
              <Size>102400</Size>
        </FileStoreSummary>
        <FileStoreSummary>
              <Name>testFile3.txt</Name>
              <FileId>6UCo1SqbqnQEoh9aKqD******</FileId>
              <UtcCreatedOn>2019-03-21T08:45:42.000Z</UtcCreatedOn>
              <Size>102400</Size>
        </FileStoreSummary>
        <FileStoreSummary>
              <Name>testFile1.txt</Name>
              <FileId>IhXXww3Eeu6uzSOSCyu******</FileId>
              <UtcCreatedOn>2019-03-21T08:45:40.000Z</UtcCreatedOn>
              <Size>102400</Size>
        </FileStoreSummary>
  </Data>
  <PageSize>10</PageSize>
  <RequestId>7C7BA526-826D-46AA-A45E-55D21E6D1583</RequestId>
  <CurrentPage>1</CurrentPage>
  <Success>true</Success>
  <Total>3</Total>
</QueryDeviceFileListResponse>

Formato JSON

{
  "PageCount": 1, 
  "Data": {
    "FileStoreSummary": [
      {
        "Name": "testFile2.txt", 
        "FileId": "xL0G67MBLBDtkR7GCfT******", 
        "UtcCreatedOn": "2019-03-21T08:45:42.000Z", 
        "Size": "102400"
      }, 
      {
        "Name": "testFile3.txt", 
        "FileId": "6UCo1SqbqnQEoh9aKqD******", 
        "UtcCreatedOn": "2019-03-21T08:45:42.000Z", 
        "Size": "102400"
      }, 
      {
        "Name": "testFile1.txt", 
        "FileId": "IhXXww3Eeu6uzSOSCyu******", 
        "UtcCreatedOn": "2019-03-21T08:45:40.000Z", 
        "Size": "102400"
      }
    ]
  }, 
  "PageSize": 10, 
  "RequestId": "7C7BA526-826D-46AA-A45E-55D21E6D1583", 
  "CurrentPage": 1, 
  "Success": true, 
  "Total": 3
}

Códigos de erro

Para obter uma lista de códigos de erro, visite o Centro de Erros de API.