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

Consulta todos os produtos.

Observações de uso

Se o valor especificado para CurrentPage for maior que o valor de PageCount ao chamar a operação QueryProductList, ProductInfo ficará vazio. Nesse caso, especifique novos valores para CurrentPage e PageSize com base no valor retornado de Total e chame a operação QueryProductList novamente para consultar os produtos.

Por exemplo, se o valor retornado de Total for 20 e o valor especificado para PageSize for 5, o valor retornado de PageCount será 4. O resultado segue a fórmula: 20/5 = 4. Se você definir CurrentPage como 1, 2, 3 ou 4, ProductInfo não estará vazio. Caso defina um valor maior que 4 para CurrentPage, como 5, ProductInfo estará vazio porque não existem dados na página 5.

Exemplo de resposta de sucesso:

{
  "RequestId": "62F56B4D-9CBC-518A-8414-CC91BB83FD04",
  "Data": {
    "PageCount": 4,
    "PageSize": 5,
    "CurrentPage": 5,
    "Total": 20,
    "List": {
      "ProductInfo": []
    }
  },
  "Code": "",
  "Success": true
}

Limites de QPS

Chame esta operação até 50 vezes por segundo por conta.

Nota
Os usuários RAM de uma conta Alibaba Cloud compartilham a cota da conta.
Quando o produto do valor de CurrentPage pelo valor de PageSize for igual ou superior a 100.000, o QPS desta operação diminui.

Nessa situação, cada conta Alibaba Cloud pode executar até 2 QPS.

Depuração

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	QueryProductList	A operação a ser executada. Defina o valor como QueryProductList.
CurrentPage	Integer	Sim	1	O número da página.
PageSize	Integer	Sim	2	O número de entradas por página. Valores válidos: 1 a 200.
IotInstanceId	String	Não	iot_instc_pu*_c-v64	O ID da instância. Visualize o ID da instância na aba Overview no console do IoT Platform. Importante Caso sua instância possua um ID, especifique-o neste parâmetro. Caso contrário, a chamada falhará. Se a instância não tiver um ID, não é necessário configurar este parâmetro. Para mais informações, consulte Visão geral.
ResourceGroupId	String	Não	rg-acfmxazb4ph****	O ID do grupo de recursos. Importante O IoT Platform permite adicionar apenas instâncias a um grupo de recursos. O parâmetro ResourceGroupId não tem mais efeito. Não é necessário configurar ResourceGroupId.
AliyunCommodityCode	String	Não	iothub_senior	O tipo do produto. Valores válidos: iothub_senior: utiliza um modelo Thing Specification Language (TSL) para o produto. iothub: não utiliza modelo TSL para o produto. Nota Se este parâmetro não for especificado, todos os produtos serão retornados.

Além dos parâmetros de solicitação específicos da operação mencionados acima, configure os parâmetros de solicitação comuns ao chamar esta operação. Para obter mais detalhes sobre os parâmetros de solicitação comuns, consulte Parâmetros comuns.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
Code	String	iot.system.SystemException	O código de erro retornado se a solicitação falhar. Para mais informações, consulte Códigos de erro.
Data	Struct		As informações do produto retornadas se a chamada for bem-sucedida. Para mais detalhes, veja os parâmetros abaixo.
CurrentPage	Integer	1	O número da página.
List	Array of ProductInfo		Os produtos consultados. Nota A lista de produtos consultados é ordenada em ordem cronológica inversa com base no horário de criação.
ProductInfo
AuthType	String	secret	O método de verificação usado para conectar os dispositivos do produto ao IoT Platform. Valores válidos: secret: DeviceSecrets foram usados para verificar os dispositivos. id2: IoT Device ID foi usado para verificar os dispositivos. x509: Certificados X.509 foram usados para verificar os dispositivos.
DataFormat	Integer	1	O formato de dados utilizado pelo protocolo de comunicação para transmitir dados entre os dispositivos e o IoT Platform. Este parâmetro é retornado apenas se AliyunCommodityCode estiver definido como iothub_senior. Valores válidos: 0: personalizado. Utiliza um formato de dados serial personalizado. Nesse cenário, os dispositivos podem enviar dados brutos, como fluxos de dados binários. O IoT Platform converte esses dados brutos em dados JSON Alink padrão por meio de um script específico de análise de dados. 1: Alink JSON. Dados no formato Alink JSON são transmitidos entre os dispositivos e o IoT Platform. O Alink é um protocolo de troca de dados predefinido no IoT Platform.
Description	String	Este é um produto de teste.	A descrição do produto.
DeviceCount	Integer	128	A quantidade de dispositivos no produto.
GmtCreate	Long	1581595942000	O horário de criação do produto. Representa um timestamp UNIX indicando o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 no Horário Universal Coordenado (UTC).
NodeType	Integer	0	O tipo de nó do produto. Retornado apenas quando AliyunCommodityCode for definido como iothub_senior. Valores válidos: 0: dispositivo. Subdispositivos não podem ser anexados a um dispositivo. Ele pode se conectar diretamente ao IoT Platform ou atuar como subdispositivo de um gateway. 1: gateway. Permite a conexão de subdispositivos. O gateway gerencia esses subdispositivos, mantém as relações topológicas e as sincroniza com o IoT Platform.
ProductKey	String	a1T27vz****	A ProductKey do produto. Trata-se de um identificador globalmente único (GUID) emitido pelo IoT Platform para cada produto.
ProductName	String	Iluminação pública	O nome do produto.
PageCount	Integer	92	O número total de páginas retornadas.
PageSize	Integer	2	A quantidade de entradas por página.
Total	Integer	184	O total de produtos.
ErrorMessage	String	Ocorreu uma exceção do sistema.	A mensagem de erro retornada caso a chamada falhe.
RequestId	String	4B4ECF2C-6222-42EC-A4B5-C12202E71CEA	O ID da solicitação.
Success	Boolean	true	Indica se a chamada foi bem-sucedida. Valores válidos: true: A chamada teve sucesso. false: A chamada falhou.

Exemplos

Exemplos de solicitações

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryProductList
&CurrentPage=1
&PageSize=2
&ResourceGroupId=rg-acfmxazb4ph****
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

<QueryProductListResponse>
  <Data>
        <PageCount>92</PageCount>
        <PageSize>2</PageSize>
        <List>
              <ProductInfo>
                    <DataFormat>1</DataFormat>
                    <ProductKey>a1A0D4t****</ProductKey>
                    <NodeType>0</NodeType>
                    <ProductName>Street light</ProductName>
                    <DeviceCount>1</DeviceCount>
                    <GmtCreate>1569233025000</GmtCreate>
                    <AuthType>secret</AuthType>
              </ProductInfo>
              <ProductInfo>
                    <DataFormat>1</DataFormat>
                    <ProductKey>a1dEvuQ****</ProductKey>
                    <NodeType>0</NodeType>
                    <ProductName>Custom sub-device</ProductName>
                    <DeviceCount>0</DeviceCount>
                    <GmtCreate>1568690432000</GmtCreate>
                    <AuthType>secret</AuthType>
              </ProductInfo>
        </List>
        <CurrentPage>1</CurrentPage>
        <Total>184</Total>
  </Data>
  <RequestId>4B4ECF2C-6222-42EC-A4B5-C12202E71CEA</RequestId>
  <Success>true</Success>
</QueryProductListResponse>

Formato JSON

{
  "Data": {
    "PageCount": 92, 
    "PageSize": 2, 
    "List": {
      "ProductInfo": [
        {
          "DataFormat": 1, 
          "ProductKey": "a1A0D4t****", 
          "NodeType": 0, 
          "ProductName": "Street light", 
          "DeviceCount": 1, 
          "GmtCreate": 1569233025000, 
          "AuthType": "secret"
        }, 
        {
          "DataFormat": 1, 
          "ProductKey": "a1dEvuQ****", 
          "NodeType": 0, 
          "ProductName": "Custom sub-device", 
          "DeviceCount": 0, 
          "GmtCreate": 1568690432000,
          "AuthType": "secret"
        }
      ]
    }, 
    "CurrentPage": 1, 
    "Total": 184
  }, 
  "RequestId": "4B4ECF2C-6222-42EC-A4B5-C12202E71CEA", 
  "Success": true
}

Códigos de erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.