ListOTAModuleVersionsByDevice - Consultar versões de módulos OTA - IoT Platform: Central de Documentação do Alibaba Cloud

Limites de chamadas

Cada conta Alibaba Cloud pode chamar esta operação até 10 vezes por segundo (QPS).

Nota

Usuários RAM compartilham a cota da conta Alibaba Cloud.

Depuração

O Alibaba Cloud oferece o OpenAPI Explorer para simplificar o uso de APIs. O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer, que também gera dinamicamente códigos de exemplo para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	ListOTAModuleVersionsByDevice	Operação a ser executada. Defina o valor como `ListOTAModuleVersionsByDevice`.
CurrentPage	Integer	Sim	1	Número da página a retornar. Valor padrão: 1.
PageSize	Integer	Sim	10	Número de entradas por página. Valor máximo: 200.
IotInstanceId	String	Não	iot_instc_pu***_c-v64********	ID da instância. Visualize o ID da instância na página Overview do console IoT Platform. Importante Obrigatório se a instância tiver ID. Sem esse parâmetro, a chamada falha. Não obrigatório se a instância não tiver página Overview ou ID. Visão geral.
ProductKey	String	Não	aluctKe****	ProductKey do produto ao qual o dispositivo pertence. Nota Ao especificar este parâmetro, especifique também DeviceName.
DeviceName	String	Não	newdevice	DeviceName do dispositivo. Nota Ao especificar este parâmetro, especifique também ProductKey.
IotId	String	Não	Q7uOhVRdZRRlDnTLv****00100	ID globalmente exclusivo do dispositivo, emitido pelo IoT Platform. Nota Se especificar este parâmetro, não será necessário informar ProductKey ou DeviceName. O parâmetro IotId define um identificador globalmente exclusivo (GUID) correspondente à combinação de ProductKey e DeviceName. Caso informe tanto o IotId quanto a combinação de ProductKey e DeviceName, o IotId terá precedência.

Esta operação também requer parâmetros de solicitação comuns.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
Code	String	iot.system.SystemException	Código de erro retornado em caso de falha na chamada. Consulte Códigos de erro.
CurrentPage	Integer	1	Número da página retornada.
Data	Array of SimpleOTAModuleInfo		Detalhes da versão do módulo OTA retornados em caso de sucesso. Consulte SimpleOTAModuleInfo nesta tabela.
SimpleOTAModuleInfo
DeviceName	String	newDevice	DeviceName do dispositivo.
IotId	String	QjIFT***000101	ID do dispositivo.
ModuleName	String	barcodeScanner	Nome do módulo OTA.
ModuleVersion	String	1,0	Versão do módulo relatada pelo dispositivo.
ProductKey	String	aluctKe****	ProductKey do produto ao qual o dispositivo pertence.
ErrorMessage	String	A system exception occurred.	Mensagem de erro. Retornada apenas se a chamada falhar.
PageCount	Integer	1	Número total de páginas retornadas.
PageSize	Integer	10	Número de versões de módulo retornadas em cada página.
RequestId	String	291438BA-6E10-4C4C-B761-243B9A0D324F	ID da solicitação.
Success	Boolean	true	Indica se a chamada foi bem-sucedida. true: Chamada bem-sucedida. false: Falha na chamada.
Total	Integer	10	Número total de versões de módulo relatadas pelo dispositivo.

Exemplos

Exemplos de solicitações

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListOTAModuleVersionsByDevice
&CurrentPage=1
&PageSize=10
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

<ListOTAModuleVersionsByDeviceResponse>
  <requestId>67AF7881-704C-40CC-B296-72F91380A117</requestId>
  <success>true</success>
  <code></code>
  <errorMessage></errorMessage>
  <PageSize>10</PageSize>
  <PageCount>1</PageCount>
  <CurrentPage>1</CurrentPage>
  <Total>1</Total>
  <Data>
        <SimpleOTAModuleInfo>
              <IotId>QjIFT***000101</IotId>
              <ModuleVersion>1.6940.1</ModuleVersion>
              <ModuleName>default</ModuleName>
              <ProductKey>a14***S</ProductKey>
              <DeviceName>newDevice</DeviceName>
        </SimpleOTAModuleInfo>
  </Data>
</ListOTAModuleVersionsByDeviceResponse>

Formato JSON

{
    "requestId": "67AF7881-704C-40CC-B296-72F91380A117",
    "success": true,
    "code": "",
    "errorMessage": null,
    "PageSize": 10,
    "PageCount": 1,
    "CurrentPage": 1,
    "Total": 1,
    "Data": {
        "SimpleOTAModuleInfo": [
            {
                "IotId": "QjIFT***000101",
                "ModuleVersion": "1.6940.1",
                "ModuleName": "default",
                "ProductKey": "a14***S",
                "DeviceName": "newDevice"
            }
        ]
    }
}

Códigos de erro

Acesse o API Error Center para obter uma lista de códigos de erro.