QueryProductList - IoT Platform - Centre de documentation Alibaba Cloud

Répertorie l'ensemble des produits.

Notes d'utilisation

Si la valeur spécifiée pour le paramètre CurrentPage est supérieure à la valeur de PageCount lors de l'appel de l'opération QueryProductList, le champ ProductInfo reste vide. Dans ce cas, spécifiez de nouvelles valeurs pour les paramètres CurrentPage et PageSize en vous basant sur la valeur renvoyée par Total, puis appelez à nouveau l'opération QueryProductList pour interroger les produits.

Par exemple, si la valeur renvoyée pour Total est 20 et que vous avez défini PageSize sur 5, la valeur de PageCount sera de 4 (calcul : 20/5 = 4). Si vous indiquez 1, 2, 3 ou 4 pour CurrentPage, le champ ProductInfo contient des données. En revanche, si vous spécifiez une valeur supérieure à 4 (par exemple 5) pour CurrentPage, le champ ProductInfo sera vide, car aucune donnée n'existe pour la page 5.

Exemple de réponse réussie :

{
  "RequestId": "62F56B4D-9CBC-518A-8414-CC91BB83FD04",
  "Data": {
    "PageCount": 4,
    "PageSize": 5,
    "CurrentPage": 5,
    "Total": 20,
    "List": {
      "ProductInfo": []
    }
  },
  "Code": "",
  "Success": true
}

Limites de QPS

Vous pouvez appeler cette opération jusqu'à 50 fois par seconde par compte.

Remarque
Les utilisateurs RAM d'un compte Alibaba Cloud partagent le quota de ce compte.
Si le produit des valeurs CurrentPage et PageSize est supérieur ou égal à 100 000, le débit QPS de cette opération diminue.

Dans ce scénario, chaque compte Alibaba Cloud est limité à 2 QPS.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. Celui-ci génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	QueryProductList	L'opération que vous souhaitez effectuer. Définissez la valeur sur QueryProductList.
CurrentPage	Integer	Yes	1	Le numéro de page.
PageSize	Integer	Yes	2	Le nombre d'entrées par page. Valeurs valides : 1 à 200.
IotInstanceId	String	No	iot_instc_pu*_c-v64	L'ID de l'instance. Vous pouvez consulter l'ID de l'instance dans l'onglet Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez le spécifier pour ce paramètre. À défaut, l'appel échouera. Si votre instance ne possède pas d'ID, il n'est pas nécessaire de configurer ce paramètre. Pour plus d'informations, consultez la rubrique Overview.
ResourceGroupId	String	No	rg-acfmxazb4ph****	L'ID du groupe de ressources. Important IoT Platform vous permet uniquement d'ajouter des instances à un groupe de ressources. Le paramètre ResourceGroupId n'a plus d'effet. Il n'est pas nécessaire de le configurer.
AliyunCommodityCode	String	No	iothub_senior	Le type de produit. Valeurs valides : iothub_senior : Un modèle TSL (Thing Specification Language) est utilisé pour le produit. iothub : Aucun modèle TSL n'est utilisé pour le produit. Remarque Si vous ne spécifiez pas ce paramètre, tous les produits sont renvoyés.

En plus des paramètres de requête spécifiques à l'opération mentionnés ci-dessus, vous devez configurer les paramètres de requête communs lors de l'appel de cette opération. Pour plus d'informations sur les paramètres de requête communs, consultez la rubrique Paramètres communs.

Paramètres de réponse

Parameter	Type	Example	Description
Code	String	iot.system.SystemException	Le code d'erreur renvoyé en cas d'échec de la requête. Pour plus d'informations, consultez la rubrique Codes d'erreur.
Data	Struct		Les informations sur le produit renvoyées en cas de succès de l'appel. Pour plus de détails, reportez-vous aux paramètres suivants.
CurrentPage	Integer	1	Le numéro de page.
List	Array of ProductInfo		Les produits interrogés. Remarque Les produits interrogés sont triés par ordre chronologique inversé, selon leur date de création.
ProductInfo
AuthType	String	secret	La méthode de vérification utilisée pour connecter les appareils du produit à IoT Platform. Valeurs valides : secret : Les DeviceSecrets ont été utilisés pour vérifier les appareils. id2 : L'ID d'appareil IoT a été utilisé pour vérifier les appareils. x509 : Des certificats X.509 ont été utilisés pour vérifier les appareils.
DataFormat	Integer	1	Le format de données utilisé par un protocole de communication pour transmettre les données entre les appareils et IoT Platform. Ce paramètre n'est renvoyé que si AliyunCommodityCode est défini sur iothub_senior. Valeurs valides : 0 : custom. Un format de données série personnalisé est utilisé. Dans ce cas, les appareils peuvent soumettre des données brutes, telles que des flux binaires. IoT Platform convertit les données brutes en données Alink JSON standard à l'aide d'un script d'analyse spécifique. 1 : Alink JSON. Des données Alink JSON sont transmises entre les appareils et IoT Platform. Alink est un protocole d'échange de données prédéfini dans IoT Platform.
Description	String	This is a test product.	La description du produit.
DeviceCount	Integer	128	Le nombre d'appareils dans le produit.
GmtCreate	Long	1581595942000	L'heure de création du produit. Cette valeur est un horodatage UNIX représentant le nombre de millisecondes écoulées depuis le 1er janvier 1970, 00:00:00 UTC (Temps universel coordonné).
NodeType	Integer	0	Le type de nœud du produit. Ce paramètre n'est renvoyé que si AliyunCommodityCode est défini sur iothub_senior. Valeurs valides : 0 : device. Les sous-appareils ne peuvent pas être associés à un appareil. Un appareil peut se connecter directement à IoT Platform ou via une passerelle en tant que sous-appareil. 1 : gateway. Les sous-appareils peuvent être associés à une passerelle. Une passerelle peut gérer les sous-appareils, maintenir les relations topologiques avec eux et synchroniser ces relations avec IoT Platform.
ProductKey	String	a1T27vz****	La ProductKey du produit. Une ProductKey est un identifiant global unique (GUID) attribué par IoT Platform à un produit.
ProductName	String	Street light	Le nom du produit.
PageCount	Integer	92	Le nombre total de pages renvoyées.
PageSize	Integer	2	Le nombre d'entrées par page.
Total	Integer	184	Le nombre total de produits.
ErrorMessage	String	A system exception occurred.	Le message d'erreur renvoyé en cas d'échec de l'appel.
RequestId	String	4B4ECF2C-6222-42EC-A4B5-C12202E71CEA	L'ID de la requête.
Success	Boolean	true	Indique si l'appel a réussi. Valeurs valides : true : L'appel a réussi. false : L'appel a échoué.

Exemples

Exemples de requêtes

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryProductList
&CurrentPage=1
&PageSize=2
&ResourceGroupId=rg-acfmxazb4ph****
&<Common request parameters>

Exemples de réponses réussies

XML format

<QueryProductListResponse>
  <Data>
        <PageCount>92</PageCount>
        <PageSize>2</PageSize>
        <List>
              <ProductInfo>
                    <DataFormat>1</DataFormat>
                    <ProductKey>a1A0D4t****</ProductKey>
                    <NodeType>0</NodeType>
                    <ProductName>Street light</ProductName>
                    <DeviceCount>1</DeviceCount>
                    <GmtCreate>1569233025000</GmtCreate>
                    <AuthType>secret</AuthType>
              </ProductInfo>
              <ProductInfo>
                    <DataFormat>1</DataFormat>
                    <ProductKey>a1dEvuQ****</ProductKey>
                    <NodeType>0</NodeType>
                    <ProductName>Custom sub-device</ProductName>
                    <DeviceCount>0</DeviceCount>
                    <GmtCreate>1568690432000</GmtCreate>
                    <AuthType>secret</AuthType>
              </ProductInfo>
        </List>
        <CurrentPage>1</CurrentPage>
        <Total>184</Total>
  </Data>
  <RequestId>4B4ECF2C-6222-42EC-A4B5-C12202E71CEA</RequestId>
  <Success>true</Success>
</QueryProductListResponse>

JSON format

{
  "Data": {
    "PageCount": 92, 
    "PageSize": 2, 
    "List": {
      "ProductInfo": [
        {
          "DataFormat": 1, 
          "ProductKey": "a1A0D4t****", 
          "NodeType": 0, 
          "ProductName": "Street light", 
          "DeviceCount": 1, 
          "GmtCreate": 1569233025000, 
          "AuthType": "secret"
        }, 
        {
          "DataFormat": 1, 
          "ProductKey": "a1dEvuQ****", 
          "NodeType": 0, 
          "ProductName": "Custom sub-device", 
          "DeviceCount": 0, 
          "GmtCreate": 1568690432000,
          "AuthType": "secret"
        }
      ]
    }, 
    "CurrentPage": 1, 
    "Total": 184
  }, 
  "RequestId": "4B4ECF2C-6222-42EC-A4B5-C12202E71CEA", 
  "Success": true
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez la rubrique Codes d'erreur de service.