QueryDeviceFileList - IoT Platform - Centro de documentación de Alibaba Cloud

Consulta la información de todos los archivos que un dispositivo cargó en IoT Platform.

Límites

La información de archivos que devuelve esta llamada a la operación no incluye las URL de descarga. Para obtener la URL de descarga de un archivo, llame a QueryDeviceFile.
Cada cuenta de Alibaba Cloud puede ejecutar un máximo de 500 consultas por segundo (QPS).

Nota
Los usuarios de RAM de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.

Depuración

Alibaba Cloud proporciona OpenAPI Explorer para simplificar el uso de las API. OpenAPI Explorer calcula automáticamente el valor de la firma. Para mayor comodidad, se recomienda llamar a esta operación desde OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo de la operación para distintos SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	QueryDeviceFileList	La operación que desea ejecutar. Establezca el valor en QueryDeviceFileList.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	El ID de la instancia. Consulte el ID de la instancia en la página Descripción general de la consola de IoT Platform. Importante Si su instancia tiene un ID, debe configurar este parámetro. De lo contrario, la llamada fallará. Si su instancia no tiene una página Descripción general ni un ID, no es necesario establecer este parámetro. Para más información, consulte Descripción general.
PageSize	Integer	No	10	El número de entradas que se devuelven en cada página. Valor máximo: 200. Valor predeterminado: 10.
ProductKey	String	No	a1BwAGV****	El ProductKey del producto al que pertenece el dispositivo. Nota Si especifica este parámetro, también debe especificar el parámetro DeviceName.
DeviceName	String	No	light	El DeviceName del dispositivo. Nota Si especifica este parámetro, también debe especificar el parámetro ProductKey.
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	El ID del dispositivo. IoT Platform emite este identificador. Nota Si especifica este parámetro, no necesita indicar ProductKey ni DeviceName. El parámetro IotId define un identificador único global (GUID) del dispositivo, que corresponde a la combinación de ProductKey y DeviceName. Si indica tanto IotId como la combinación de ProductKey y DeviceName, IotId tendrá prioridad.
CurrentPage	Integer	No	1	El número de la página que se devuelve. La numeración comienza en 1. Valor predeterminado: 1.

Además de los parámetros de solicitud específicos de esta operación, debe especificar los parámetros de solicitud comunes al llamarla. Para más información, consulte Parámetros de solicitud comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	El código de error que se devuelve si la llamada falla. Para más información, consulte Códigos de error.
CurrentPage	Integer	1	El número de la página devuelta.
Data	Array of FileSummary		La información de la lista de archivos que se devuelve si la llamada es exitosa.
FileSummary
FileId	String	xL0G67MBLBDtkR7GCfT******	El ID de cada archivo. Este valor funciona como identificador único del archivo.
Name	String	testFile2.txt	El nombre del archivo.
Size	String	1024000	El tamaño del archivo. Unidad: KB.
UtcCreatedOn	String	2019-03-21T08:45:42.000Z	La hora en la que se creó el archivo.
ErrorMessage	String	A system exception occurred.	El mensaje de error que se devuelve si la llamada falla.
PageCount	Integer	1	El número total de páginas.
PageSize	Integer	10	El número de entradas devueltas por página.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	El ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. true: la llamada fue exitosa. false: la llamada terminó con errores.
Total	Integer	2	El número total de archivos.

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

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 error

Para consultar la lista de códigos de error, visite el centro de errores de API.