QueryProduct - IoT Platform - Centre de documentation Alibaba Cloud

Interroge les détails d'un produit.

Limites

Chaque compte Alibaba Cloud peut exécuter un maximum de 50 requêtes par seconde (QPS).

Remarque

Les utilisateurs RAM d'un compte Alibaba Cloud partagent le quota du compte.

Débogage

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

Paramètres de la requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	QueryProduct	L'opération que vous souhaitez effectuer. Définissez la valeur sur QueryProduct.
ProductKey	String	Oui	a1BwAGV****	Le ProductKey du produit que vous souhaitez interroger. Un ProductKey est un GUID émis par IoT Platform pour un produit. Vous pouvez utiliser la console IoT Platform ou appeler l'opération QueryProductList pour afficher les informations sur tous les produits du compte actuel.
IotInstanceId	String	Non	iot_instc_pu***_c-v64********	L'ID de l'instance. Vous pouvez afficher l'Aperçu de l'instance dans la console IoT Platform. Important Si votre instance possède un ID, vous devez configurer ce paramètre. Si vous ne définissez pas ce paramètre, l'appel échoue. Si votre instance ne possède pas de page Aperçu ou d'ID, vous n'avez pas besoin de définir ce paramètre. Pour plus d'informations, consultez Aperçu.

En plus des paramètres de requête spécifiques à l'opération mentionnés ci-dessus, vous devez spécifier les paramètres de requête communs lorsque vous appelez cette opération. Pour plus d'informations, consultez Paramètres de requête communs.

Paramètres de réponse

Paramètre	Type	Exemple	Description
Code	String	iot.system.SystemException	Le code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations, consultez Codes d'erreur.
Data	Struct		Les informations sur le produit renvoyées si l'appel aboutit.
AliyunCommodityCode	String	iothub_senior	Le type de produit. Ce paramètre indique si un modèle de langage de spécification des objets (TSL) a été utilisé. Valeurs possibles : iothub_senior : Un modèle TSL a été utilisé. iothub : Aucun modèle TSL n'a été utilisé.
AuthType	String	secret	La méthode d'authentification utilisée pour connecter les appareils du produit à IoT Platform. Valeurs possibles : secret : Les DeviceSecrets ont été utilisés pour authentifier les appareils. id2 : L'ID d'appareil IoT Internet a été utilisé pour authentifier les appareils. x509 : Des certificats X.509 ont été utilisés pour authentifier les appareils.
CategoryKey	String	Lighting	L'identifiant de la catégorie à laquelle appartient le produit. Ce paramètre est renvoyé si le produit utilise le modèle TSL d'une catégorie standard prédéfinie par IoT Platform. Ce paramètre est disponible si le paramètre AliyunCommodityCode est défini sur iothub_senior.
CategoryName	String	Street Lamp	Le nom de la catégorie de produit. Ce paramètre est renvoyé si le produit utilise le modèle TSL d'une catégorie standard prédéfinie par IoT Platform. Ce paramètre est disponible si le paramètre AliyunCommodityCode est défini sur iothub_senior.
DataFormat	Integer	1	Le format de données utilisé par un protocole de communication pour transmettre des données entre les appareils et IoT Platform. Ce paramètre est disponible si le paramètre AliyunCommodityCode est défini sur iothub_senior. Valeurs possibles : 0 : personnalisé. Un format de données série personnalisé a été utilisé. Dans ce cas, l'appareil peut soumettre des données brutes, telles que des flux de données binaires. IoT Platform convertit les données brutes en données Alink JSON standard à l'aide d'un script d'analyse de données spécifié. 1 : Alink JSON. Les données Alink JSON sont transmises entre les appareils et IoT Platform. Alink est un protocole d'échange de données prédéfini par IoT Platform.
Description	String	Smart street light	La description du produit.
DeviceCount	Integer	0	Le nombre d'appareils sous le produit.
GmtCreate	Long	1581595942000	L'heure de création du produit. La valeur est un horodatage en millisecondes.
Id2	Boolean	false	Indique si l'ID d'appareil IoT Internet est activé. Valeurs possibles : true : L'ID d'appareil IoT Internet est activé. false : L'ID d'appareil IoT Internet est désactivé.
NetType	Integer	3	La méthode de connexion réseau. Valeurs possibles : 3 : Wi-Fi. 6 : réseau cellulaire (2G/3G/4G/5G). 7 : Ethernet. 8 : autres.
NodeType	Integer	0	Le type de nœud du produit. Ce paramètre est disponible si le paramètre AliyunCommodityCode est défini sur iothub_senior. Valeurs possibles : 0 : appareil. Les sous-appareils ne peuvent pas être attachés à un appareil. Un appareil peut se connecter directement à IoT Platform ou en tant que sous-appareil d'une passerelle. 1 : passerelle. Les sous-appareils peuvent être attachés à une passerelle. Une passerelle peut gérer les sous-appareils, maintenir les relations topologiques avec les sous-appareils et synchroniser les relations topologiques avec IoT Platform.
Owner	Boolean	true	Indique si l'opération a été appelée par le propriétaire du produit. true : oui. false : non.
ProductKey	String	a1T27vz****	Le ProductKey du produit. Lorsque vous créez un produit, un ProductKey est l'identifiant global unique (GUID) émis par IoT Platform pour le produit.
ProductName	String	Street light	Le nom du produit.
ProductSecret	String	U5tW7i44uilc****	Le ProductSecret du produit.
ProductStatus	String	DEVELOPMENT_STATUS	Le statut du produit. DEVELOPMENT_STATUS : Le produit est en cours de développement. RELEASE_STATUS : Le produit a été publié.
ProtocolType	String	modbus	Le type de protocole utilisé par les sous-appareils pour se connecter à une passerelle. Ce paramètre est disponible si le paramètre AliyunCommodityCode est défini sur iothub_senior et le paramètre NodeType est défini sur 1. Valeurs possibles : modbus : Modbus. opc-ua : OPC UA. customize : protocole personnalisé. ble : BLE. zigbee : ZigBee.
ValidateType	Integer	1	Le niveau de vérification des données. Valeurs possibles : 2 : aucune vérification. IoT Platform ne vérifie pas les données. Toutes les données sont transférées. Dans la console IoT Platform, les données ne sont pas affichées dans l'onglet Données TSL de la page Détails de l'appareil. 1 : vérification de bas niveau. IoT Platform vérifie uniquement les champs identifier et dataType des données. Toutes les données sont transférées. 0 : vérification de haut niveau. IoT Platform vérifie tous les champs des données. Seules les données qui passent la vérification sont transférées. Les produits créés avant le 14 octobre 2020 prennent en charge uniquement la vérification de haut niveau. Les produits créés le 14 octobre 2020 ou après prennent en charge la vérification de bas niveau ou aucune vérification. Après la vérification, vous pouvez afficher les données qui passent ou échouent à la vérification. Dans la console IoT Platform, les données sont affichées dans l'onglet Données TSL de la page Détails de l'appareil. Les données qui échouent à la vérification ne sont pas affichées. Vous pouvez afficher les données qui échouent à la vérification dans le paramètre checkFailedData des données transférées. Pour plus d'informations, consultez Formats de données.
ErrorMessage	String	A system exception occurred.	Le message d'erreur renvoyé en cas d'échec de l'appel.
RequestId	String	E4F94B97-1D64-4080-BFD2-67461667AA43	L'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é.

Exemples

Exemples de requêtes

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryProduct
&ProductKey=a1BwAGV****
&<Common request parameters>

Exemples de réponses réussies

XML format

<QueryProductResponse>
  <Data>
        <Owner>true</Owner>
        <CategoryName>Street lighting</CategoryName>
        <DataFormat>1</DataFormat>
        <ProductKey>a1BwAGV****</ProductKey>
        <ProductStatus>DEVELOPMENT_STATUS</ProductStatus>
        <GmtCreate>1581595942000</GmtCreate>
        <ProductSecret>U5tW7i44uilc****</ProductSecret>
        <NodeType>0</NodeType>
        <ProductName>Street light</ProductName>
        <ValidateType>1</ValidateType>
        <DeviceCount>0</DeviceCount>
        <NetType>3</NetType>
        <AuthType>secret</AuthType>
        <CategoryKey>Lighting</CategoryKey>
        <Id2>false</Id2>
        <AliyunCommodityCode>iothub_senior</AliyunCommodityCode>
  </Data>
  <RequestId>DA5A3C45-D457-48ED-9A20-AEDEA8503401</RequestId>
  <Success>true</Success>
</QueryProductResponse>

JSON format

{
    "Data": {
        "Owner": true,
        "CategoryName": "Street lighting",
        "DataFormat": 1,
        "ProductKey": "a1BwAGV****",
        "ProductStatus": "DEVELOPMENT_STATUS",
        "GmtCreate": 1581595942000,
        "ProductSecret": "U5tW7i44uilc****",
        "NodeType": 0,
        "ProductName": "Street light"
        "ValidateType":1,
        "DeviceCount": 0,
        "NetType": 3,
        "AuthType": "secret",
        "CategoryKey": "Lighting",
        "Id2": false,
        "AliyunCommodityCode": "iothub_senior"
    },
    "RequestId": "DA5A3C45-D457-48ED-9A20-AEDEA8503401",
    "Success": true
}

Codes d'erreur

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