QueryDeviceFileList - IoT Platform - Centre de documentation Alibaba Cloud

Récupère les informations sur tous les fichiers téléchargés vers IoT Platform depuis un appareil.

Limites

Les informations sur les fichiers renvoyées par cet appel ne contiennent pas les URL de téléchargement. Pour obtenir l'URL de téléchargement d'un fichier, appelez QueryDeviceFile.
Chaque compte Alibaba Cloud peut effectuer jusqu'à 500 requêtes par seconde (QPS).

Remarque
Les utilisateurs RAM d'un compte Alibaba Cloud partagent le quota de ce compte.

Débogage

Alibaba Cloud met à votre disposition OpenAPI Explorer pour simplifier l'utilisation des API. OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de la requête

Parameter	Type	Required	Example	Description
Action	String	Yes	QueryDeviceFileList	Opération à exécuter. Définissez la valeur sur QueryDeviceFileList.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	ID de l'instance. Vous pouvez consulter l'ID de l'instance sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez configurer ce paramètre. À défaut, l'appel échoue. Si votre instance ne dispose pas de page Overview ou d'ID, inutile de définir ce paramètre. Pour plus d'informations, consultez Overview.
PageSize	Integer	No	10	Nombre d'entrées à renvoyer par page. Valeur maximale : 200. Valeur par défaut : 10.
ProductKey	String	No	a1BwAGV****	ProductKey du produit auquel appartient l'appareil. Remarque Si vous spécifiez ce paramètre, vous devez également spécifier le paramètre DeviceName.
DeviceName	String	No	light	DeviceName de l'appareil. Remarque Si vous spécifiez ce paramètre, vous devez également spécifier le paramètre ProductKey.
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	ID de l'appareil. Cet ID est émis par IoT Platform. Remarque Si vous spécifiez ce paramètre, inutile de spécifier ProductKey ni DeviceName. Le paramètre IotId correspond à l'identifiant global unique (GUID) de l'appareil, qui associe ProductKey et DeviceName. Si vous spécifiez à la fois IotId et la combinaison ProductKey/DeviceName, IotId est prioritaire.
CurrentPage	Integer	No	1	Numéro de la page à renvoyer. La numérotation commence à 1. Valeur par défaut : 1.

Outre les paramètres spécifiques à l'opération, vous devez inclure les paramètres de requête communs lors de l'appel. Pour plus d'informations, consultez Common request parameters.

Paramètres de réponse

Parameter	Type	Example	Description
Code	String	iot.system.SystemException	Code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations, consultez Error codes.
CurrentPage	Integer	1	Numéro de la page renvoyée.
Data	Array of FileSummary		Liste des fichiers renvoyée en cas de succès de l'appel.
FileSummary
FileId	String	xL0G67MBLBDtkR7GCfT******	ID de chaque fichier. Il s'agit de l'identifiant unique du fichier.
Name	String	testFile2.txt	Nom du fichier.
Size	String	1024000	Taille du fichier. Unité : Ko.
UtcCreatedOn	String	2019-03-21T08:45:42.000Z	Date et heure de création du fichier.
ErrorMessage	String	A system exception occurred.	Message d'erreur renvoyé en cas d'échec de l'appel.
PageCount	Integer	1	Nombre total de pages.
PageSize	Integer	10	Nombre d'entrées renvoyées par page.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	ID de la requête.
Success	Boolean	true	Indique si l'appel a réussi. true : L'appel a réussi. false : L'appel a échoué.
Total	Integer	2	Nombre total de fichiers.

Exemples

Exemple de requête

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

Exemple de réponse réussie

Format 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>

Format 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
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, visitez le Centre d'erreurs de l'API.