QueryDeviceListByDeviceGroup - IoT Platform - Centro de documentación de Alibaba Cloud

Consulta los dispositivos de un grupo.

Límites

Cada cuenta de Alibaba Cloud admite un máximo de 5 consultas por segundo (QPS).

Nota

Los usuarios RAM de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.

Depuración

Alibaba Cloud ofrece OpenAPI Explorer para simplificar el uso de la API. OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, se recomienda llamar a esta operación desde OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	QueryDeviceListByDeviceGroup	La operación que desea ejecutar. Establezca el valor en QueryDeviceListByDeviceGroup.
GroupId	String	Sí	7DIgqIl1Ijnh****	El ID del grupo. Este ID es el identificador único global (GUID) del grupo.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	El ID de la instancia. Consulte el ID de la instancia en la página de Overview de la consola de IoT Platform. Importante Si su instancia tiene un ID, configure este parámetro. De lo contrario, la llamada fallará. Si su instancia no tiene página de Overview o ID, omita este parámetro. Para obtener más información, consulte Descripción general.
PageSize	Integer	No	10	Número de entradas por página.
CurrentPage	Integer	No	1	Número de página que se devolverá.

Además de los parámetros específicos de esta operación, debe especificar los parámetros de solicitud comunes. Para obtener más información, consulte Parámetros de solicitud comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	Código de error devuelto si la llamada falla. Para obtener más información, consulte Códigos de error.
Data	Array of SimpleDeviceInfo		Lista de dispositivos devuelta si la llamada es exitosa. Para obtener más información, consulte el parámetro SimpleDeviceInfo a continuación.
SimpleDeviceInfo
DeviceName	String	ios_1207_08	Nombre del dispositivo.
IotId	String	TfmUAeJjQQhCPH84UVNn0010c6****	ID del dispositivo. Es el identificador único asignado por IoT Platform.
ProductKey	String	a1hWjHD****	ProductKey del producto al que pertenece el dispositivo.
ProductName	String	WIFIdevice	ProductName del producto al que pertenece el dispositivo.
ErrorMessage	String	A system exception occurred.	Mensaje de error devuelto si la llamada falla.
Page	Integer	1	Número de página devuelta.
PageCount	Integer	1	Número total de páginas.
PageSize	Integer	10	Número de entradas por página.
RequestId	String	B1A921D9-1061-4D45-9F12-EA6B0FDEDE30	ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. true: La llamada fue exitosa. false: La llamada falló.
Total	Integer	3	Número total de dispositivos.

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

Formato XML

<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>

Formato JSON

{
  "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
}

Códigos de error

Para obtener una lista de códigos de error, visite el Centro de errores de API.