QueryDevice - IoT Platform - Centre de documentation Alibaba Cloud

Interroge les appareils d'un produit.

Description

L'opération QueryDevice renvoie jusqu'à un million d'appareils par appel.

Limites de QPS

Vous pouvez appeler cette opération API 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 des paramètres CurrentPage et PageSize est supérieur ou égal à 100 000, le nombre de requêtes par seconde (QPS) autorisé pour cette opération diminue.

Dans ce cas, vous pouvez appeler cette opération API jusqu'à deux fois par seconde par compte.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. L'outil 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	QueryDevice	Opération à effectuer. Définissez la valeur sur QueryDevice.
ProductKey	String	Yes	a1BwAGV****	ProductKey du produit auquel l'appareil appartient.
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 spécifier cet ID pour ce paramètre. Sinon, l'appel échoue. Si aucune page Overview ni aucun ID n'est généré pour votre instance, ne configurez pas ce paramètre. Pour plus d'informations, consultez Overview.
PageSize	Integer	No	10	Nombre d'entrées à renvoyer par page. Valeurs autorisées : 1 à 50. Valeur par défaut : 10.
CurrentPage	Integer	No	1	Numéro de la page à renvoyer. Valeur par défaut : 1.
NextToken	String	No	TGlzdFJlc291cm***	Jeton utilisé pour récupérer la page suivante des résultats de la requête. Ne configurez pas ce paramètre lors de la première requête. Spécifiez le jeton obtenu lors de la requête précédente pour le paramètre NextToken. Si le produit des valeurs des paramètres PageSize et CurrentPage est supérieur à 10 000, vous devez configurer le paramètre NextToken. Sinon, aucune donnée n'est renvoyée. Important Si vous configurez le paramètre NextToken, le produit des valeurs des paramètres PageSize et CurrentPage doit être inférieur à 1 000 000. Sinon, aucune donnée n'est renvoyée.

Outre les paramètres de requête spécifiques à l'opération, vous devez inclure les paramètres de requête communs lors de l'appel. Pour plus d'informations, consultez Paramètres 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 DeviceInfo		Informations sur les appareils renvoyées en cas de succès. Les détails figurent dans le paramètre DeviceInfo. Remarque Les informations sur les appareils sont triées par ordre chronologique inverse (de la création la plus récente à la plus ancienne).
DeviceInfo
DeviceId	String	dwnS41bhNxjslDAI****	ID de l'appareil. Remarque Ce paramètre est obsolète. N'utilisez pas ce paramètre pour identifier un appareil. Utilisez le paramètre IotId ou la combinaison des paramètres ProductKey et DeviceName.
DeviceName	String	light	Nom de l'appareil.
DeviceSecret	String	sLefbFmN9SYfnWLJTePG893XNuRV****	DeviceSecret de l'appareil.
DeviceStatus	String	ONLINE	Statut de l'appareil. Valeurs valides : ONLINE : L'appareil est en ligne. OFFLINE : L'appareil est hors ligne. UNACTIVE : L'appareil n'est pas activé. DISABLE : L'appareil est désactivé.
DeviceType	String	Lighting	Catégorie du produit auquel l'appareil appartient. Remarque Ce paramètre n'est pas renvoyé.
GmtCreate	String	Wed, 20-Feb-2019 02:16:09 GMT	Heure de création de l'appareil (format GMT).
GmtModified	String	Wed, 20-Feb-2019 02:16:09 GMT	Heure de la dernière mise à jour des informations sur l'appareil (format GMT).
IotId	String	Q7uOhVRdZRRlDnTLv****00100	ID de l'appareil. Il s'agit d'un identifiant unique attribué par IoT Platform à l'appareil.
Nickname	String	Smart light	Alias de l'appareil.
ProductKey	String	a1BwAGV****	ProductKey du produit auquel l'appareil appartient.
UtcCreate	String	2019-02-20T02:16:09.000Z	Heure de création de l'appareil (format UTC).
UtcModified	String	2019-02-20T02:16:09.000Z	Heure de la dernière mise à jour des informations sur l'appareil (format UTC).
ErrorMessage	String	A system exception occurred.	Message d'erreur renvoyé en cas d'échec de l'appel.
NextToken	String	TGlzdFJlc291cm***	Jeton utilisé pour récupérer la page suivante des résultats de la requête. Spécifiez ce paramètre dans la requête suivante pour obtenir la page suivante. Si le paramètre NextToken est vide, il n'y a pas de page suivante.
Page	Integer	1	Numéro de la page renvoyée.
PageCount	Integer	1	Nombre total de pages renvoyées.
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. Valeurs valides : true : L'appel a réussi. false : L'appel a échoué.
Total	Integer	2	Nombre total d'appareils.

Exemples

Exemples de requêtes

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

Exemples de réponses réussies

Format XML

<QueryDeviceResponse>
  <PageCount>1</PageCount>
  <NextToken>TGlzdFJlc291cm***</NextToken>
  <Data>
        <DeviceInfo>
              <DeviceId>Av8NGHGtwPrH9BYG****</DeviceId>
              <DeviceName>Av8NGHGtwPrH9BYGLMBi</DeviceName>
              <ProductKey>a1dafDE****</ProductKey>
              <DeviceSecret>d7GYhf5hfcPHDe1bXSd3n9MjO1G3****</DeviceSecret>
              <UtcModified>2019-02-20T02:16:09.000Z</UtcModified>
              <GmtCreate>Wed, 20-Feb-2019 02:16:09 GMT</GmtCreate>
              <UtcCreate>2019-02-20T02:16:09.000Z</UtcCreate>
              <GmtModified>Wed, 20-Feb-2019 02:16:09 GMT</GmtModified>
              <IotId>Av8NGHGtwPrH9BYGLMBi00****</IotId>
              <DeviceStatus>UNACTIVE</DeviceStatus>
              <Nickname>SensorInShanghai</Nickname>
        </DeviceInfo>
        <DeviceInfo>
              <DeviceId>zNIcSmWQ9BPJlmkj****</DeviceId>
              <DeviceName>zNIcSmWQ9BPJlmkjn3H1</DeviceName>
              <ProductKey>a1dafDE****</ProductKey>
              <DeviceSecret>C27XXmC18yLIEDXvUj6FSlvgO7ag****</DeviceSecret>
              <UtcModified>2019-02-20T02:16:09.000Z</UtcModified>
              <GmtCreate>Wed, 20-Feb-2019 02:16:09 GMT</GmtCreate>
              <UtcCreate>2019-02-20T02:16:09.000Z</UtcCreate>
              <GmtModified>Wed, 20-Feb-2019 02:16:09 GMT</GmtModified>
              <IotId>zNIcSmWQ9BPJlmkjn3H100****</IotId>
              <DeviceStatus>UNACTIVE</DeviceStatus>
              <Nickname>DriverInShanghai</Nickname>
        </DeviceInfo>
  </Data>
  <Page>1</Page>
  <PageSize>10</PageSize>
  <RequestId>CD9E5F99-A095-4A05-9256-D924EA3075E8</RequestId>
  <Success>true</Success>
  <Total>2</Total>
</QueryDeviceResponse>

Format JSON

{
  "PageCount": 1,
  "NextToken":"TGlzdFJlc291cm***", 
  "Data": {
    "DeviceInfo": [
      {
        "DeviceId": "Av8NGHGtwPrH9BYG****", 
        "DeviceName": "Av8NGHGtwPrH9BYGLMBi", 
        "ProductKey": "a1dafDE****", 
        "DeviceSecret": "d7GYhf5hfcPHDe1bXSd3n9MjO1G3****", 
        "UtcModified": "2019-02-20T02:16:09.000Z", 
        "GmtCreate": "Wed, 20-Feb-2019 02:16:09 GMT", 
        "UtcCreate": "2019-02-20T02:16:09.000Z", 
        "GmtModified": "Wed, 20-Feb-2019 02:16:09 GMT", 
        "IotId": "Av8NGHGtwPrH9BYGLMBi00****", 
        "DeviceStatus": "UNACTIVE", 
        "Nickname": "SensorInShanghai"
      }, 
      {
        "DeviceId": "zNIcSmWQ9BPJlmkj****", 
        "DeviceName": "zNIcSmWQ9BPJlmkjn3H1", 
        "ProductKey": "a1dafDE****", 
        "DeviceSecret": "C27XXmC18yLIEDXvUj6FSlvgO7ag****", 
        "UtcModified": "2019-02-20T02:16:09.000Z", 
        "GmtCreate": "Wed, 20-Feb-2019 02:16:09 GMT", 
        "UtcCreate": "2019-02-20T02:16:09.000Z", 
        "GmtModified": "Wed, 20-Feb-2019 02:16:09 GMT", 
        "IotId": "zNIcSmWQ9BPJlmkjn3H100****", 
        "DeviceStatus": "UNACTIVE", 
        "Nickname": "DriverInShanghai"
      }
    ]
  }, 
  "Page": 1, 
  "PageSize": 10, 
  "RequestId": "CD9E5F99-A095-4A05-9256-D924EA3075E8", 
  "Success": true, 
  "Total": 2
}

Codes d'erreur

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