QueryDeviceListByDeviceGroup - IoT Platform - Centre de documentation Alibaba Cloud

Interroge les appareils d'un groupe.

Limites

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

Remarque

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

Débogage

Alibaba Cloud met à disposition OpenAPI Explorer pour simplifier l'utilisation des API. 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	QueryDeviceListByDeviceGroup	Opération à effectuer. Définissez la valeur sur QueryDeviceListByDeviceGroup.
GroupId	String	Yes	7DIgqIl1Ijnh****	ID du groupe. Il s'agit de l'identifiant global unique (GUID) du groupe.
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 échoue. Si votre instance ne possède pas de page Overview ou d'ID, vous n'avez pas besoin de définir ce paramètre. Pour plus d'informations, consultez la rubrique Vue d'ensemble.
PageSize	Integer	No	10	Nombre d'entrées à renvoyer par page.
CurrentPage	Integer	No	1	Numéro de la page à renvoyer.

Outre les 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 à cette opération. Pour plus d'informations, consultez la rubrique 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 la rubrique Codes d'erreur.
Data	Array of SimpleDeviceInfo		Informations sur la liste des appareils renvoyées en cas de succès de l'appel. Pour plus d'informations, consultez le paramètre SimpleDeviceInfo ci-dessous.
SimpleDeviceInfo
DeviceName	String	ios_1207_08	Nom de chaque appareil.
IotId	String	TfmUAeJjQQhCPH84UVNn0010c6****	ID de l'appareil. Il s'agit de l'identifiant unique émis par IoT Platform pour l'appareil.
ProductKey	String	a1hWjHD****	ProductKey du produit auquel appartient l'appareil.
ProductName	String	WIFIdevice	ProductName du produit auquel appartient l'appareil.
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	B1A921D9-1061-4D45-9F12-EA6B0FDEDE30	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	3	Nombre total d'appareils.

Exemples

Exemples de requêtes

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceListByDeviceGroup
&GroupId=7DIgqIl1Ijnh****
&CurrentPage=1
&PageSize=10
&<Common request parameters>

Exemples de réponses réussies

XML format

<QueryDeviceListByDeviceGroupResponse>
      <PageCount>1</PageCount>
      <Data>
            <SimpleDeviceInfo>
                  <DeviceName>ios_1207_08</DeviceName>
                  <ProductKey>a1hWjHD****</ProductKey>
                  <ProductName>WIFIdevice</ProductName>
                  <IotId>TfmUAeJjQQhCPH84UVNn0010c6****</IotId>
            </SimpleDeviceInfo>
            <SimpleDeviceInfo>
                  <DeviceName>ios_1207_07</DeviceName>
                  <ProductKey>a1hWjHD****</ProductKey>
                  <ProductName>WIFIgateway</ProductName>
                  <IotId>wVPeAksaboXBlRgvZNHQ001031****</IotId>
            </SimpleDeviceInfo>
            <SimpleDeviceInfo>
                  <DeviceName>E1IPK25iL4CTOwnuI2yt</DeviceName>
                  <ProductKey>a1mV8bK****</ProductKey>
                  <ProductName>yanlv</ProductName>
                  <IotId>E1IPK25iL4CTOwnuI2yt001059****</IotId>
            </SimpleDeviceInfo>
      </Data>
      <PageSize>10</PageSize>
      <Page>1</Page>
      <RequestId>B1A921D9-1061-4D45-9F12-EA6B0FDEDE30</RequestId>
      <Success>true</Success>
      <Total>3</Total>
</QueryDeviceListByDeviceGroupResponse>

JSON format

{
  "PageCount": 1,
  "Data": {
    "SimpleDeviceInfo": [
      {
        "DeviceName": "ios_1207_08",
        "ProductKey": "a1hWjHD****",
        "ProductName": "WIFIdevice",
        "IotId": "TfmUAeJjQQhCPH84UVNn0010c6****"
      },
      {
        "DeviceName": "ios_1207_07",
        "ProductKey": "a1hWjHD****",
        "ProductName": "WIFIgateway",
        "IotId": "wVPeAksaboXBlRgvZNHQ001031****"
      },
      {
        "DeviceName": "E1IPK25iL4CTOwnuI2yt",
        "ProductKey": "a1mV8bK****",
        "ProductName": "yanlv",
        "IotId": "E1IPK25iL4CTOwnuI2yt001059****"
      }
    ]
  },
  "PageSize": 10,
  "Page": 1,
  "RequestId": "B1A921D9-1061-4D45-9F12-EA6B0FDEDE30",
  "Success": true,
  "Total": 3
}

Codes d'erreur

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