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

Consulta os detalhes de um produto.

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 OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos que você chame 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	QueryProduct	A operação a ser executada. Defina o valor como QueryProduct.
ProductKey	String	Sim	a1BwAGV****	O ProductKey do produto a ser consultado. O ProductKey é um GUID emitido pelo IoT Platform para um produto. Use o console do IoT Platform ou chame a operação QueryProductList para visualizar as informações sobre todos os produtos da conta atual.
IotInstanceId	String	Não	iot_instc_pu***_c-v64********	O ID da instância. Visualize o ID da instância na página Overview no console do IoT Platform. Importante Se sua instância possuir um ID, configure este parâmetro obrigatoriamente. Caso contrário, a chamada falhará. Se sua instância não tiver uma página Overview ou ID, não é necessário definir este parâmetro. Para mais informações, consulte Visão geral.

Além dos parâmetros específicos da operação mencionados anteriormente, 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
Code	String	iot.system.SystemException	O código de erro retornado se a chamada falhar. Para mais informações, consulte Códigos de erro.
Data	Struct		As informações do produto retornadas se a chamada for bem-sucedida.
AliyunCommodityCode	String	iothub_senior	O tipo do produto. Este parâmetro indica se um modelo Thing Specification Language (TSL) foi utilizado. Valores válidos: iothub_senior: Um modelo TSL foi utilizado. iothub: Nenhum modelo TSL foi utilizado.
AuthType	String	secret	O método de autenticação usado para conectar os dispositivos do produto ao IoT Platform. Valores válidos: secret: DeviceSecrets foram usados para autenticar os dispositivos. id2: IoT Internet Device ID foi usado para autenticar os dispositivos. x509: Certificados X.509 foram usados para autenticar os dispositivos.
CategoryKey	String	Lighting	O identificador da categoria à qual o produto pertence. Este parâmetro é retornado se o produto utilizar o modelo TSL de uma categoria padrão predefinida pelo IoT Platform. Disponível quando o parâmetro AliyunCommodityCode estiver definido como iothub_senior.
CategoryName	String	Street Lamp	O nome da categoria do produto. Retornado caso o produto utilize o modelo TSL de uma categoria padrão predefinida pelo IoT Platform. Aplicável apenas se o parâmetro AliyunCommodityCode for igual a iothub_senior.
DataFormat	Integer	1	O formato de dados utilizado por um protocolo de comunicação para transmitir dados entre os dispositivos e o IoT Platform. Disponível quando o parâmetro AliyunCommodityCode estiver definido como iothub_senior. Valores válidos: 0: personalizado. Utiliza um formato de dados seriais personalizado. Nesse caso, o dispositivo pode enviar dados brutos, como fluxos de dados binários. O IoT Platform converte os dados brutos em dados JSON Alink padrão usando um script de análise de dados especificado. 1: JSON Alink. Dados JSON Alink são transmitidos entre os dispositivos e o IoT Platform. O Alink é um protocolo de troca de dados predefinido pelo IoT Platform.
Description	String	Smart street light	A descrição do produto.
DeviceCount	Integer	0	A quantidade de dispositivos associados ao produto.
GmtCreate	Long	1581595942000	O momento da criação do produto. O valor é um timestamp em milissegundos.
Id2	Boolean	false	Indica se o IoT Internet Device ID estava ativado. Valores válidos: true: IoT Internet Device ID ativado. false: IoT Internet Device ID desativado.
NetType	Integer	3	O método de conexão de rede. Valores válidos: 3: Wi-Fi. 6: rede celular (2G/3G/4G/5G). 7: Ethernet. 8: outros.
NodeType	Integer	0	O tipo de nó do produto. Disponível quando o parâmetro AliyunCommodityCode estiver definido como iothub_senior. Valores válidos: 0: dispositivo. Subdispositivos não podem ser anexados a um dispositivo. Um dispositivo pode se conectar ao IoT Platform diretamente ou como subdispositivo de um gateway. 1: gateway. Subdispositivos podem ser anexados a um gateway. Um gateway gerencia subdispositivos, mantém os relacionamentos topológicos com eles e sincroniza esses relacionamentos com o IoT Platform.
Owner	Boolean	true	Indica se a operação foi chamada pelo proprietário do produto. true: sim. false: não.
ProductKey	String	a1T27vz****	O ProductKey do produto. Ao criar um produto, o ProductKey atua como o identificador globalmente único (GUID) emitido pelo IoT Platform para esse produto.
ProductName	String	Street light	O nome do produto.
ProductSecret	String	U5tW7i44uilc****	O ProductSecret do produto.
ProductStatus	String	DEVELOPMENT_STATUS	O status do produto. DEVELOPMENT_STATUS: O produto está em desenvolvimento. RELEASE_STATUS: O produto foi publicado.
ProtocolType	String	modbus	O tipo de protocolo usado pelos subdispositivos para se conectarem a um gateway. Disponível quando o parâmetro AliyunCommodityCode estiver definido como iothub_senior e o parâmetro NodeType estiver definido como 1. Valores válidos: modbus: Modbus. opc-ua: OPC UA. customize: protocolo personalizado. ble: BLE. zigbee: ZigBee.
ValidateType	Integer	1	O nível de verificação de dados. Valores válidos: 2: sem verificação. O IoT Platform não verifica os dados. Todos os dados são encaminhados. No console do IoT Platform, os dados não aparecem na aba TSL Data da página Device Details. 1: verificação de baixo nível. O IoT Platform verifica apenas os campos identifier e dataType dos dados. Todos os dados são encaminhados. 0: verificação de alto nível. O IoT Platform verifica todos os campos dos dados. Apenas os dados aprovados na verificação são encaminhados. Produtos criados antes de 14 de outubro de 2020 suportam apenas verificação de alto nível. Produtos criados em ou após 14 de outubro de 2020 suportam verificação de baixo nível ou nenhuma verificação. Após a verificação, visualize os dados aprovados ou reprovados. No console do IoT Platform, os dados aparecem na aba TSL Data da página Device Details. Dados reprovados na verificação não são exibidos. Visualize os dados reprovados na verificação no parâmetro checkFailedData dos dados encaminhados. Para mais informações, consulte Formatos de dados.
ErrorMessage	String	A system exception occurred.	A mensagem de erro retornada se a chamada falhar.
RequestId	String	E4F94B97-1D64-4080-BFD2-67461667AA43	O ID da solicitação.
Success	Boolean	true	Indica se a chamada foi bem-sucedida. true: A chamada foi bem-sucedida. false: A chamada falhou.

Exemplos

Exemplos de solicitações

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryProduct
&ProductKey=a1BwAGV****
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

<QueryProductResponse>
  <Data>
        <Owner>true</Owner>
        <CategoryName>Street lighting</CategoryName>
        <DataFormat>1</DataFormat>
        <ProductKey>a1BwAGV****</ProductKey>
        <ProductStatus>DEVELOPMENT_STATUS</ProductStatus>
        <GmtCreate>1581595942000</GmtCreate>
        <ProductSecret>U5tW7i44uilc****</ProductSecret>
        <NodeType>0</NodeType>
        <ProductName>Street light</ProductName>
        <ValidateType>1</ValidateType>
        <DeviceCount>0</DeviceCount>
        <NetType>3</NetType>
        <AuthType>secret</AuthType>
        <CategoryKey>Lighting</CategoryKey>
        <Id2>false</Id2>
        <AliyunCommodityCode>iothub_senior</AliyunCommodityCode>
  </Data>
  <RequestId>DA5A3C45-D457-48ED-9A20-AEDEA8503401</RequestId>
  <Success>true</Success>
</QueryProductResponse>

Formato JSON

{
    "Data": {
        "Owner": true,
        "CategoryName": "Street lighting",
        "DataFormat": 1,
        "ProductKey": "a1BwAGV****",
        "ProductStatus": "DEVELOPMENT_STATUS",
        "GmtCreate": 1581595942000,
        "ProductSecret": "U5tW7i44uilc****",
        "NodeType": 0,
        "ProductName": "Street light"
        "ValidateType":1,
        "DeviceCount": 0,
        "NetType": 3,
        "AuthType": "secret",
        "CategoryKey": "Lighting",
        "Id2": false,
        "AliyunCommodityCode": "iothub_senior"
    },
    "RequestId": "DA5A3C45-D457-48ED-9A20-AEDEA8503401",
    "Success": true
}

Códigos de erro

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