QueryDeviceByStatus - IoT Platform - Centre de documentation Alibaba Cloud

Notes d'utilisation

Lorsqu'un appareil change d'état, le nouvel état prend effet sous 10 secondes. Tant que la mise à jour n'est pas effective, l'appareil reste identifiable uniquement par son état précédent.

Limites QPS

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

Remarque

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

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Par souci de simplicité, nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	QueryDeviceByStatus	Opération à effectuer. Définissez la valeur sur QueryDeviceByStatus.
Status	Integer	Oui	1	État de l'appareil. Valeurs valides : 0 : L'appareil est inactif. 1 : L'appareil est en ligne. 3 : L'appareil est hors ligne. 8 : L'appareil est désactivé.
IotInstanceId	String	Non	iot_instc_pu*_c-v64	ID de l'instance. Vous pouvez consulter l'ID de l'instance dans l'onglet Overview de la console IoT Platform. Important Si l'instance possède un ID, vous devez spécifier ce paramètre. À défaut, la requête échouera. Si l'onglet Overview ou l'ID de l'instance n'apparaît pas dans la console IoT Platform, il n'est pas nécessaire de spécifier ce paramètre.
ProductKey	String	Non	a1BwAGV****	ProductKey du produit auquel l'appareil appartient.
CurrentPage	Integer	Non	1	Numéro de page.
PageSize	Integer	Non	10	Nombre d'entrées par page. Valeurs valides : 1 à 50.
ResourceGroupId	String	Non	rg-acfm4l5tcwd***	ID du groupe de ressources. Important IoT Platform ne prend en charge la gestion des groupes de ressources qu'au niveau de l'instance. Le paramètre ResourceGroupId est ignoré. Il n'est pas nécessaire de le spécifier.

Outre les paramètres de requête spécifiques à l'opération, vous devez indiquer les paramètres de requête communs lors de l'appel. Pour plus d'informations, consultez la rubrique Paramètres communs.

Paramètres de réponse

Paramètre	Type	Exemple	Description
Code	String	iot.system.SystemException	Code d'erreur renvoyé en cas d'échec. Pour plus d'informations, consultez la section Codes d'erreur.
Data	Array of SimpleDeviceInfo		Informations sur l'appareil renvoyées en cas de succès. Le paramètre SimpleDeviceInfo contient les détails de l'appareil.
SimpleDeviceInfo
DeviceName	String	light	Nom de l'appareil.
DeviceSecret	String	sLefbFmN9SYfnWLJTePG893XNuRV****	Secret de l'appareil.
GmtCreate	String	2021-02-18 10:46:32	Heure de création de l'appareil (GMT).
GmtModified	String	2021-02-18 10:46:32	Heure de la dernière modification de l'appareil (GMT).
IotId	String	Av8NGHGtwPrH9BYGLMBi00****	ID de l'appareil.
Nickname	String	SensorInShanghai	Alias de l'appareil.
ProductKey	String	a1BwAGV****	ProductKey du produit auquel l'appareil appartient.
Status	String	ONLINE	État de l'appareil. Valeurs valides : UNACTIVE : L'appareil est inactif. ONLINE : L'appareil est en ligne. OFFLINE : L'appareil est hors ligne. DISABLE : L'appareil est désactivé.
UtcCreate	String	2021-02-18T02:46:32.000Z	Heure de création de l'appareil (UTC).
UtcModified	String	2021-02-18T02:46:32.000Z	Heure de la dernière modification de l'appareil (UTC).
ErrorMessage	String	A system exception occurred.	Message d'erreur renvoyé en cas d'échec.
Page	Integer	1	Numéro de page.
PageCount	Integer	1	Nombre total de pages.
PageSize	Integer	10	Nombre d'entrées par page.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	ID de la requête.
Success	Boolean	true	Indique si la requête a abouti. Valeurs valides : true false
Total	Integer	2	Nombre total d'appareils renvoyés.

Exemples

Exemples de requêtes

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

Exemples de réponses réussies

Format XML

<QueryDeviceByStatusResponse>
      <RequestId>CD9E5F99-A095-4A05-9256-D924EA3075E8</RequestId>
      <Success>true</Success>
      <CurrentPage>1</CurrentPage>
      <PageSize>10</PageSize>
      <TotalPageCount>1</TotalPageCount>
      <TotalCount>2</TotalCount>
      <Data>
            <SimpleDeviceInfo>
                  <IotId>Av8NGHGtwPrH9BYGLMBi00****</IotId>
                  <DeviceName>Av8NGHG***</DeviceName>
                  <ProductKey>a1dafDE****</ProductKey>
                  <DeviceSecret>d7GYhf5hfcPHDe1bXSd3n9MjO1G3****</DeviceSecret>
                  <UtcModified>2021-02-18T02:46:32.000Z</UtcModified>
                  <GmtCreate>2021-02-18 10:46:32</GmtCreate>
                  <UtcCreate>2021-02-18T02:46:32.000Z</UtcCreate>
                  <GmtModified>2021-02-18 10:46:32</GmtModified>
                  <Status>UNACTIVE</Status>
                  <Nickname>SensorInShanghai</Nickname>
            </SimpleDeviceInfo>
            <SimpleDeviceInfo>
                  <IotId>zNIcSmWQ9BPJlmkjn3H100****</IotId>
                  <DeviceName>zNIcSmWQ***</DeviceName>
                  <ProductKey>a1dafDE****</ProductKey>
                  <DeviceSecret>C27XXmC18yLIEDXvUj6FSlvgO7ag****</DeviceSecret>
                  <UtcModified>2021-02-09T09:44:55.000Z</UtcModified>
                  <GmtCreate>2021-02-09 17:44:55</GmtCreate>
                  <UtcCreate>2021-02-09T09:44:55.000Z</UtcCreate>
                  <GmtModified>2021-02-09 17:44:55</GmtModified>
                  <DeviceStatus>UNACTIVE</DeviceStatus>
                  <Nickname>DriverInShanghai</Nickname>
            </SimpleDeviceInfo>
      </Data>
</QueryDeviceByStatusResponse>

Format JSON

{
  "RequestId": "CD9E5F99-A095-4A05-9256-D924EA3075E8", 
  "Success": true,  
  "CurrentPage": 1, 
  "PageSize": 10, 
  "TotalPageCount": 1,
  "TotalCount": 2,
  "Data": {
    "SimpleDeviceInfo": [
      {
        "IotId": "Av8NGHGtwPrH9BYGLMBi00****", 
        "DeviceName": "Av8NGHG***", 
        "ProductKey": "a1dafDE****", 
        "DeviceSecret": "d7GYhf5hfcPHDe1bXSd3n9MjO1G3****", 
        "UtcModified": "2021-02-18T02:46:32.000Z", 
        "GmtCreate": "2021-02-18 10:46:32", 
        "UtcCreate": "2021-02-18T02:46:32.000Z", 
        "GmtModified": "2021-02-18 10:46:32", 
        "Status": "UNACTIVE", 
        "Nickname": "SensorInShanghai"
      }, 
      {
        "IotId": "zNIcSmWQ9BPJlmkjn3H100****", 
        "DeviceName": "zNIcSmWQ***", 
        "ProductKey": "a1dafDE****", 
        "DeviceSecret": "C27XXmC18yLIEDXvUj6FSlvgO7ag****", 
        "UtcModified": "2021-02-09T09:44:55.000Z", 
        "GmtCreate": "2021-02-09 17:44:55", 
        "UtcCreate": "2021-02-09T09:44:55.000Z", 
        "GmtModified": "2021-02-09 17:44:55", 
        "DeviceStatus": "UNACTIVE", 
        "Nickname": "DriverInShanghai"
      }
    ]
  }  
}

Codes d'erreur

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