QueryPageByApplyId - IoT Platform: Central de Documentação do Alibaba Cloud

Consulta as informações de vários dispositivos registrados.

Limites

Cada conta Alibaba Cloud pode executar no máximo 50 consultas por segundo (QPS).

Nota

Os usuários RAM de uma conta Alibaba Cloud compartilham a cota dessa conta.

Depuração

O Alibaba Cloud oferece o OpenAPI Explorer para simplificar o uso da API. O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	QueryPageByApplyId	Operação a ser executada. Defina o valor como QueryPageByApplyId.
ApplyId	Long	Sim	1295006	ID da aplicação. Visualize o ID da aplicação na resposta da operação BatchRegisterDeviceWithApplyId ou BatchRegisterDevice.
IotInstanceId	String	Não	iot_instc_pu***_c-v64********	ID da instância. Visualize o ID da instância na página Overview no console do IoT Platform. Importante Se a instância possuir um ID, configure este parâmetro. Caso contrário, a chamada falhará. Se a instância não tiver uma página Overview ou ID, não é necessário definir este parâmetro. Para mais informações, consulte Overview.
PageSize	Integer	Não	10	Número de entradas a serem retornadas em cada página. Valor máximo: 50. Valor padrão: 10.
CurrentPage	Integer	Não	1	Número da página a ser retornada. Valor padrão: 1.

Além dos parâmetros de solicitação específicos da operação mencionados acima, especifique os parâmetros de solicitação comuns ao chamar esta operação. Para mais informações, consulte Parâmetros de solicitação comuns.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
ApplyDeviceList	Array of ApplyDeviceInfo		Lista de dispositivos registrados retornada em caso de sucesso na chamada. O parâmetro ApplyDeviceInfo contém os detalhes dos dispositivos registrados.
ApplyDeviceInfo
DeviceId	String	gQG2GJ2y10m6hIk8****	ID do dispositivo (obsoleto). Nota Este parâmetro não é mais utilizado. Não o use para identificar um dispositivo. Utilize o parâmetro IotId ou a combinação dos parâmetros ProductKey e DeviceName para essa finalidade.
DeviceName	String	light	DeviceName do dispositivo.
DeviceSecret	String	SkfeXXKrTgp1DbDxYr74mfJ5cnui****	DeviceSecret do dispositivo.
IotId	String	vWxNur6BUApsqjv9****000100	ID do dispositivo. Trata-se do identificador exclusivo emitido pelo IoT Platform para o dispositivo.
Code	String	iot.system.SystemException	Código de erro retornado se a chamada falhar. Para mais informações, consulte Códigos de erro.
ErrorMessage	String	A system exception occurred.	Mensagem de erro retornada se a chamada falhar.
Page	Integer	1	Número da página retornada.
PageCount	Integer	1	Número total de páginas.
PageSize	Integer	10	Número de entradas retornadas por página.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	ID da solicitação.
Success	Boolean	true	Indica se a chamada foi bem-sucedida. true: A chamada foi bem-sucedida. false: A chamada falhou.
Total	Integer	2	Número total de dispositivos.

Exemplos

Exemplos de solicitações

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

Exemplos de respostas de sucesso

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 erro

Para obter uma lista de códigos de erro, visite o API Error Center.