ListProductByTags - IoT Platform - Centre de documentation Alibaba Cloud

Interroge les produits par tag.

Limites

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

Remarque
Les utilisateurs RAM d'un compte Alibaba Cloud partagent le quota du compte.
Spécifiez une clé de tag ou une paire clé-valeur de tag pour la recherche.
Si vous spécifiez plusieurs tags, la relation logique entre eux est OR.

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 requête

Parameter	Type	Required	Example	Description
Action	String	Yes	ListProductByTags	Opération à effectuer. Définissez la valeur sur ListProductByTags.
ProductTag.N.TagKey	String	Yes	room	Clés des tags de produit.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	ID de l'instance. Vous pouvez afficher 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. Sinon, l'appel échoue. Si votre instance ne dispose pas de page Overview ou d'ID, vous n'avez pas besoin de définir ce paramètre. Pour plus d'informations, consultez Overview.
CurrentPage	Integer	No	1	Numéro de la page à renvoyer.
PageSize	Integer	No	10	Nombre d'entrées à renvoyer par page. Valeur maximale : 50.
ProductTag.N.TagValue	String	No	102	Valeurs des tags de produit.

En plus des paramètres de requête spécifiques à l'opération, vous devez spécifier les paramètres de requête communs lors de l'appel de cette opération. Pour plus d'informations, consultez Paramètres de requête communs.

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 Codes d'erreur.
ErrorMessage	String	A system exception occurred.	Message d'erreur renvoyé en cas d'échec de l'appel.
ProductInfos	Array of ProductInfo		Détails des produits renvoyés en cas de succès de l'appel. Les détails figurent dans le paramètre ProductInfo. Remarque Les informations sur les produits renvoyées sont triées par ordre chronologique inverse selon l'heure de création des produits.
ProductInfo
CreateTime	Long	1545355537000	Heure de création du produit.
Description	String	This is a test product.	Description du produit.
NodeType	Integer	0	Type de nœud du produit. Valeurs valides : 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 eux et synchroniser ces relations avec IoT Platform.
ProductKey	String	a1BwAGV****	ProductKey du produit. Le ProductKey est un identifiant unique global (GUID) émis par IoT Platform pour un nouveau produit.
ProductName	String	Street light	Nom du produit.
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é.

Exemples

Exemples de requêtes

https://iot.cn-shanghai.aliyuncs.com/?Action=ListProductByTags
&CurrentPage=1
&PageSize=10
&ProductTag.1.TagKey=Reen
&ProductTag.1.TagValue=reen
&ProductTag.2.TagKey=Lock
&ProductTag.2.TagValue=1234
&<Common request parameters>

Exemples de réponses réussies

XML format

<ListProductByTagsResponse>
  <RequestId>09AA366E-81EC-4CF0-B49E-61BCD7C95338</RequestId>
  <Success>true</Success>
  <ProductInfos>
        <ProductInfo>
              <ProductKey>a1BwAGV****</ProductKey>
              <NodeType>0</NodeType>
              <CreateTime>1581595942000</CreateTime>
              <ProductName>Street light</ProductName>
        </ProductInfo>
        <ProductInfo>
              <ProductKey>a1PO***</ProductKey>
              <NodeType>0</NodeType>
              <CreateTime>1580898565000</CreateTime>
              <ProductName>Sensor </ProductName>
        </ProductInfo>
  </ProductInfos>
</ListProductByTagsResponse>

JSON format

{
    "RequestId": "09AA366E-81EC-4CF0-B49E-61BCD7C95338",
    "Success": true,
    "ProductInfos": {
        "ProductInfo": [
            {
                "ProductKey": "a1BwAGV****",
                "NodeType": 0,
                "CreateTime": 1581595942000,
                "ProductName": "Street light"
            },
            {
                "ProductKey": "a1PO***",
                "NodeType": 0,
                "CreateTime": 1580898565000,
                "ProductName": "Sensor"
            }
        ]
    }
}

Codes d'erreur

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