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

Consulta grupos de dispositivos con paginación.

Límites

Cada cuenta de Alibaba Cloud puede ejecutar un máximo de 100 consultas por segundo (QPS).

Nota

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

Depuración

Alibaba Cloud proporciona 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 en OpenAPI Explorer. OpenAPI Explorer 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í	QueryDeviceGroupList	La operación que desea realizar. Establezca el valor en QueryDeviceGroupList.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	El ID de la instancia. Puede consultar el ID de la instancia en la página Descripción general de la consola de IoT Platform. Importante Si su instancia tiene un ID, debe configurar este parámetro. Si no establece este parámetro, la llamada fallará. Si su instancia no tiene página Descripción general ni ID, no es necesario establecer este parámetro. Para obtener más información, consulte Descripción general.
PageSize	Integer	No	10	El número de entradas que se devolverán en cada página. Valor máximo: 200. Valor predeterminado: 10.
SuperGroupId	String	No	8vDubXr4nUvZkNgk9mle010200	El ID del grupo principal. Especifique este parámetro para consultar los subgrupos de un grupo principal.
GroupName	String	No	GroupName1	El nombre del grupo. Si especifica este parámetro, el sistema consulta los grupos por nombre. Puede realizar una búsqueda aproximada por nombre de grupo. Si no especifica este parámetro, el sistema consulta todos los grupos.
CurrentPage	Integer	No	1	El número de página que se devolverá. Valor predeterminado: 1.
GroupTypes.N	RepeatList	No	LINK_PLATFORM_DYNAMIC	El tipo de grupo que se va a consultar. Establezca el valor en LINK_PLATFORM_DYNAMIC. Este valor indica un grupo dinámico. Si no especifica este parámetro, se consulta un grupo estático de forma predeterminada.

Además de los parámetros de solicitud específicos de la operación mencionados anteriormente, debe especificar los parámetros de solicitud comunes al llamar a esta operación. 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	El código de error devuelto si la llamada falla. Para obtener más información, consulte Códigos de error.
CurrentPage	Integer	1	El número de la página actual.
Data	Array of GroupInfo		La información del grupo devuelta si la llamada se realiza correctamente. Para obtener más información, consulte GroupInfo. Nota Los grupos devueltos se ordenan en orden cronológico inverso según la hora de creación.
GroupInfo
GroupDesc	String	usefulGroup	La descripción del grupo.
GroupId	String	Kzt9FD8wje8o****	El ID del grupo.
GroupName	String	test1	El nombre del grupo.
GroupType	String	LINK_PLATFORM_DYNAMIC	El tipo del grupo.
UtcCreate	String	2018-10-09T02:58:34.000Z	La hora en que se creó el grupo.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la llamada falla.
PageCount	Integer	3	El número total de páginas.
PageSize	Integer	10	El número de entradas devueltas en cada página.
RequestId	String	BEFCA316-D6C7-470C-81ED-1FF4FFD4AA0D	El ID de la solicitud.
Success	Boolean	true	Indica si la llamada se realizó correctamente. true: La llamada se realizó correctamente. false: La llamada falló.
Total	Integer	24	El número total de registros devueltos.

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceGroupList
&PageSize=10
&CurrentPage=1
&GroupTypes.1=LINK_PLATFORM_DYNAMIC
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<QueryDeviceGroupListResponse>
  <PageCount>3</PageCount>
  <Data>
        <GroupInfo>
              <GroupName>test1</GroupName>
              <UtcCreate>2021-10-01T02:58:34.000Z</UtcCreate>
              <GroupId>Kzt9FD8wje8o***</GroupId>
              <GroupType>LINK_PLATFORM_DYNAMIC</GroupType>
        </GroupInfo>
        <GroupInfo>
              <GroupName>test2</GroupName>
              <UtcCreate>2021-10-01T02:56:40.000Z</UtcCreate>
              <GroupId>0ayrSQ3DSd7***</GroupId>
              <GroupType>LINK_PLATFORM_DYNAMIC</GroupType>
        </GroupInfo>
        <GroupInfo>
              <GroupDesc>Test</GroupDesc>
              <GroupName>test3</GroupName>
              <UtcCreate>2021-10-01T05:38:27.000Z</UtcCreate>
              <GroupId>oWXlIQeFZtzC***</GroupId>
              <GroupType>LINK_PLATFORM_DYNAMIC</GroupType>
        </GroupInfo>
        <GroupInfo>
              <GroupName>ylv0915</GroupName>
              <UtcCreate>2021-10-01T04:51:56.000Z</UtcCreate>
              <GroupId>SfEiVapLPUjB***</GroupId>
              <GroupType>LINK_PLATFORM_DYNAMIC</GroupType>
        </GroupInfo>
        <GroupInfo>
              <GroupName>ydlv</GroupName>
              <UtcCreate>2021-10-01T14:35:51.000Z</UtcCreate>
              <GroupId>z2S2h9NsDTZm***</GroupId>
              <GroupType>LINK_PLATFORM_DYNAMIC</GroupType>
        </GroupInfo>
        <GroupInfo>
              <GroupName>ldh_group_3</GroupName>
              <UtcCreate>2021-10-01T12:26:20.000Z</UtcCreate>
              <GroupId>chn5fkjin***</GroupId>
              <GroupType>LINK_PLATFORM_DYNAMIC</GroupType>
        </GroupInfo>
        <GroupInfo>
              <GroupDesc>ddd</GroupDesc>
              <GroupName>ylvgisbim</GroupName>
              <UtcCreate>2021-10-01T11:41:20.000Z</UtcCreate>
              <GroupId>ncUZ8DjWYaB9***</GroupId>
              <GroupType>LINK_PLATFORM_DYNAMIC</GroupType>
        </GroupInfo>
        <GroupInfo>
              <GroupName>abc</GroupName>
              <UtcCreate>2021-10-01T09:14:30.000Z</UtcCreate>
              <GroupId>zpdvwxzBdt4F***</GroupId>
              <GroupType>LINK_PLATFORM_DYNAMIC</GroupType>
        </GroupInfo>
        <GroupInfo>
              <GroupName>test11</GroupName>
              <UtcCreate>2021-10-01T07:22:39.000Z</UtcCreate>
              <GroupId>BTaudF16X2xK***</GroupId>
              <GroupType>LINK_PLATFORM_DYNAMIC</GroupType>
        </GroupInfo>
        <GroupInfo>
              <GroupName>testy</GroupName>
              <UtcCreate>2021-10-01T01:58:06.000Z</UtcCreate>
              <GroupId>PrTm3VOeggPw***</GroupId>
              <GroupType>LINK_PLATFORM_DYNAMIC</GroupType>
        </GroupInfo>
  </Data>
  <PageSize>10</PageSize>
  <RequestId>BEFCA316-D6C7-470C-81ED-1FF4FFD4AA0D</RequestId>
  <CurrentPage>1</CurrentPage>
  <Success>true</Success>
  <Total>24</Total>
</QueryDeviceGroupListResponse>

Formato JSON

{
    "PageCount":3,
    "Data":{
        "GroupInfo":[
            {
                "GroupName":"test1",
                "UtcCreate":"2021-10-01T02:58:34.000Z",
                "GroupId":"Kzt9FD8wje8o***",
                "GroupType": "LINK_PLATFORM_DYNAMIC"
            },
            {
                "GroupName":"test2",
                "UtcCreate":"2021-10-01T02:56:40.000Z",
                "GroupId":"0ayrSQ3DSd7***",
                "GroupType": "LINK_PLATFORM_DYNAMIC"
            },
            {
                "GroupDesc":"Test",
                "GroupName":"test3",
                "UtcCreate":"2021-10-01T05:38:27.000Z",
                "GroupId":"oWXlIQeFZtzC***",
                "GroupType":"LINK_PLATFORM_DYNAMIC"
            },
            {
                "GroupName":"ylv0915",
                "UtcCreate":"2021-10-01T04:51:56.000Z",
                "GroupId":"SfEiVapLPUjB***",
                "GroupType": "LINK_PLATFORM_DYNAMIC"
            },
            {
                "GroupName":"ydlv",
                "UtcCreate":"2021-10-01T14:35:51.000Z",
                "GroupId":"z2S2h9NsDTZm***",
                "GroupType": "LINK_PLATFORM_DYNAMIC"
            },
            {
                "GroupName":"ldh_group_3",
                "UtcCreate":"2021-10-01T12:26:20.000Z",
                "GroupId":"chn5fkjin***",
                "GroupType": "LINK_PLATFORM_DYNAMIC"
            },
            {
                "GroupDesc":"ddd",
                "GroupName":"ylvgisbim",
                "UtcCreate":"2021-10-01T11:41:20.000Z",
                "GroupId":"ncUZ8DjWYaB9***",
                "GroupType": "LINK_PLATFORM_DYNAMIC"
            },
            {
                "GroupName":"abc",
                "UtcCreate":"2021-10-01T09:14:30.000Z",
                "GroupId":"zpdvwxzBdt4F***",
                "GroupType": "LINK_PLATFORM_DYNAMIC"
            },
            {
                "GroupName":"test11",
                "UtcCreate":"2021-10-01T07:22:39.000Z",
                "GroupId":"BTaudF16X2xK***",
                "GroupType": "LINK_PLATFORM_DYNAMIC"
            },
            {
                "GroupName":"testy",
                "UtcCreate":"2021-10-01T01:58:06.000Z",
                "GroupId":"PrTm3VOeggPw***",
                "GroupType": "LINK_PLATFORM_DYNAMIC"
            }
        ]
    },
    "PageSize":10,
    "RequestId":"BEFCA316-D6C7-470C-81ED-1FF4FFD4AA0D",
    "CurrentPage":1,
    "Success":true,
    "Total":24
}

Códigos de error

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