QueryDeviceByTags - IoT Platform - Centre de documentation Alibaba Cloud

Limites

Spécifiez un maximum de 10 tags par appel.
Chaque compte Alibaba Cloud est limité à 5 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. Cet outil calcule automatiquement la valeur de signature. Nous vous recommandons d'appeler cette opération via OpenAPI Explorer, qui 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	QueryDeviceByTags	Opération à effectuer. Définissez la valeur sur QueryDeviceByTags.
Tag.N.TagKey	String	Yes	room	Clé du tag de l'appareil.
Tag.N.TagValue	String	Yes	101	Valeur du tag de l'appareil.
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 échouera. Si votre instance ne dispose pas de page Overview ou d'ID, il n'est pas nécessaire de définir ce paramètre. Pour plus d'informations, consultez Overview.
CurrentPage	Integer	No	1	Numéro de la page à renvoyer. Valeur par défaut : 1.
PageSize	Integer	No	10	Nombre d'entrées à renvoyer par page. Valeur maximale : 50. Valeur par défaut : 10.

En plus des paramètres de requête spécifiques à cette opération, vous devez spécifier les paramètres de requête communs lors de l'appel. 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.
Data	Array of SimpleDeviceInfo		Informations sur l'appareil renvoyées en cas de succès de l'appel. Le paramètre SimpleDeviceInfo inclut les détails des appareils.
SimpleDeviceInfo
DeviceName	String	light1	DeviceName de l'appareil.
IotId	String	Q7uOhVRdZRRlDnTLv****00100	ID de l'appareil. Il s'agit de l'identifiant unique attribué à l'appareil par IoT Platform.
ProductKey	String	a1BwAGV****	ProductKey du produit auquel l'appareil appartient.
ProductName	String	lamp	Nom du produit.
ErrorMessage	String	A system exception occurred.	Message d'erreur renvoyé en cas d'échec de l'appel.
Page	Integer	1	Numéro de la page renvoyée.
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	1	Nombre total d'enregistrements.

Exemples

Exemple de requête

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceByTags
&CurrentPage=1
&PageSize=10
&Tag.1.TagKey=room
&Tag.1.TagValue=101
&Tag.2.TagKey=city
&Tag.2.TagValue=hangzhou
&<Common request parameters>

Exemple de réponse en cas de succès

XML format

<QueryDeviceByTags>
  <PageCount>1</PageCount>
  <Data>
        <SimpleDeviceInfo>
              <DeviceName>1102jichu02</DeviceName>
              <ProductKey>a1SM5S1****</ProductKey>
              <IotId>GookTiUcwqRbHosp9Ta10****3a00</IotId>
              <ProductName>TEST</ProductName>
        </SimpleDeviceInfo>
  </Data>
  <PageSize>10</PageSize>
  <Page>1</Page>
  <RequestId>2B5091E4-32D5-4884-A5B2-2E8E713D84AF</RequestId>
  <Success>true</Success>
  <Total>1</Total>
</QueryDeviceByTags>

JSON format

{
    "PageCount": 1,
    "Data": {
        "SimpleDeviceInfo": [
            {
                "DeviceName": "1102jichu02",
                "ProductKey": "a1SM5S1****",
                "IotId": "GookTiUcwqRbHosp9Ta10****3a00",
                "ProductName": "TEST"
            }
        ]
    },
    "PageSize": 10,
    "Page": 1,
    "RequestId": "2B5091E4-32D5-4884-A5B2-2E8E713D84AF",
    "Success": true,
    "Total": 1
}

Codes d'erreur

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