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

Consulta la información de varios dispositivos registrados.

Límites

Cada cuenta de Alibaba Cloud admite un máximo de 50 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í	QueryPageByApplyId	La operación que desea ejecutar. Establezca el valor en QueryPageByApplyId.
ApplyId	Long	Sí	1295006	El ID de la aplicación. Consulte el ID de la aplicación en la respuesta de la operación BatchRegisterDeviceWithApplyId o BatchRegisterDevice.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	El ID de la instancia. Consulte el ID de la instancia en la página 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 Overview ni 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. Valor máximo: 50. Valor predeterminado: 10.
CurrentPage	Integer	No	1	Número de página que se devolverá. Valor predeterminado: 1.

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
ApplyDeviceList	Array of ApplyDeviceInfo		Lista de dispositivos registrados que se devuelve si la llamada es exitosa. El parámetro ApplyDeviceInfo incluye los detalles de dichos dispositivos.
ApplyDeviceInfo
DeviceId	String	gQG2GJ2y10m6hIk8****	ID del dispositivo (obsoleto). Nota Este parámetro está en desuso; no lo utilice para identificar dispositivos. En su lugar, use el parámetro IotId o la combinación de ProductKey y DeviceName.
DeviceName	String	light	DeviceName del dispositivo.
DeviceSecret	String	SkfeXXKrTgp1DbDxYr74mfJ5cnui****	DeviceSecret del dispositivo.
IotId	String	vWxNur6BUApsqjv9****000100	ID del dispositivo. Es el identificador único asignado por IoT Platform.
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.
ErrorMessage	String	A system exception occurred.	Mensaje de error devuelto si la llamada falla.
Page	Integer	1	Número de la página devuelta.
PageCount	Integer	1	Número total de páginas.
PageSize	Integer	10	Número de entradas por página.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. true: La llamada fue exitosa. false: La llamada falló.
Total	Integer	2	Número total de dispositivos.

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryPageByApplyId
&ApplyId=1234567
&PageSize=10
&CurrentPage=1
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<QueryPageByApplyIdResponse>
  <PageCount>1</PageCount>
  <ApplyDeviceList>
        <ApplyDeviceInfo>
              <DeviceId>vWxNur6BUApsqjv9****</DeviceId>
              <DeviceName>APItest</DeviceName>
              <DeviceSecret>tXXEtily4XuV7WS1fosJoDkhRIIU****</DeviceSecret>
              <IotId>vWxNur6BUApsqjv****4000100</IotId>
        </ApplyDeviceInfo>
        <ApplyDeviceInfo>
              <DeviceId>hoiwszKPYmHk074H****</DeviceId>
              <DeviceName>awfg</DeviceName>
              <DeviceSecret>BYpg1b2nmuq21BO7fxOogYQQZd9z****</DeviceSecret>
              <IotId>hoiwszKPYmHk074HA****000100</IotId>
        </ApplyDeviceInfo>
  </ApplyDeviceList>
  <Page>1</Page>
  <PageSize>10</PageSize>
  <RequestId>762F7AAD-8B87-4C65-BBF3-4575B002B384</RequestId>
  <Success>true</Success>
  <Total>2</Total>
</QueryPageByApplyIdResponse>

Formato JSON

{
    "PageCount": 1,
    "ApplyDeviceList": {
        "ApplyDeviceInfo": [
            {
                "DeviceId": "vWxNur6BUApsqjv9****",
                "DeviceName": "APItest",
                "DeviceSecret": "tXXEtily4XuV7WS1fosJoDkhRIIU****",
                "IotId": "vWxNur6BUApsqjv****4000100"
            },
            {
                "DeviceId": "hoiwszKPYmHk074H****",
                "DeviceName": "awfg",
                "DeviceSecret": "BYpg1b2nmuq21BO7fxOogYQQZd9z****",
                "IotId": "hoiwszKPYmHk074HA****000100"
            }
        ]
    },
    "Page": 1,
    "PageSize": 10,
    "RequestId": "762F7AAD-8B87-4C65-BBF3-4575B002B384",
    "Success": true,
    "Total": 2
}

Códigos de error

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