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

Cria um produto.

Observações de uso

Se for necessário um modelo Thing Specification Language (TSL) para criar o produto, defina o parâmetro AliyunCommodityCode como iothub_senior e especifique o parâmetro DataFormat. Para obter mais informações, consulte a seção Parâmetros da solicitação deste tópico.

Limites de QPS

Você pode chamar esta operação até 50 vezes por segundo por conta.

Nota

Os usuários do Resource Access Management (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 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

Parameter	Type	Required	Example	Description
Action	String	Yes	CreateProduct	Operação a ser executada. Defina o valor como CreateProduct.
NodeType	Integer	Yes	0	Tipo de nó do produto. Valores válidos: 0: dispositivo. Subdispositivos não podem ser anexados a um dispositivo. Um dispositivo pode se conectar diretamente ao IoT Platform ou atuar como subdispositivo de um gateway. Se você utilizar o dispositivo como subdispositivo de um gateway, especifique ProtocolType. 1: gateway. Subdispositivos podem ser anexados a um gateway. O gateway gerencia subdispositivos, mantém relacionamentos topológicos com eles e sincroniza esses relacionamentos com o IoT Platform.
ProductName	String	Yes	Light	Nome do produto. O nome deve ter entre 4 e 30 caracteres e pode conter letras, dígitos e sublinhados (_). Cada caractere chinês conta como dois caracteres. Importante Cada nome de produto deve ser exclusivo na instância atual.
IotInstanceId	String	No	iot-*-v64*	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, este parâmetro é obrigatório. Caso contrário, a solicitação falhará. Se a página Overview ou o ID da instância não estiverem visíveis no console do IoT Platform, não especifique este parâmetro. Para mais informações, consulte Visão geral.
DataFormat	Integer	No	1	Formato dos dados. Valores válidos: 0: formato de dados personalizado. 1: formato Alink JSON.
Description	String	No	Product test	Descrição do produto. Pode ter até 100 caracteres.
AliyunCommodityCode	String	No	iothub_senior	Edição do produto. Por padrão, se você não especificar este parâmetro, o sistema cria automaticamente um produto da Basic Edition. Não é possível usar um modelo TSL para definir o produto. Para especificar este parâmetro, defina o valor como iothub_senior. Nesse caso, o sistema cria um produto compatível com modelos TSL. Também é necessário especificar o parâmetro DataFormat. Importante Para produtos da Basic Edition, não é possível utilizar o recurso de depuração online no console do IoT Platform.
Id2	Boolean	No	false	Não especifique este parâmetro.
ProtocolType	String	No	modbus	Protocolo usado pelos dispositivos do produto para se conectar ao gateway. Se AliyunCommodityCode estiver definido como iothub_senior e for necessário um gateway para conectar os dispositivos do produto ao IoT Platform, este parâmetro é obrigatório. Valores válidos: modbus: Modbus. opc-ua: Open Platform Communication Unified Architecture (OPC UA). customize: protocolo personalizado. ble: Bluetooth Low Energy (BLE). zigbee: ZigBee.
NetType	String	No	WIFI	Método de conexão de rede. Este parâmetro é obrigatório se os dispositivos do produto forem gateways ou dispositivos conectados diretamente. Valores válidos: WIFI CELLULAR ETHERNET OTHER Valor padrão: WIFI.
JoinPermissionId	String	No	8***	Não especifique este parâmetro.
ResourceGroupId	String	No	rg-acfmxazb4ph***	ID do grupo de recursos. Importante O IoT Platform permite gerenciar apenas recursos de instância por grupos de recursos. O parâmetro ResourceGroupId não tem efeito nesta solicitação, portanto não o especifique. Os grupos de recursos configurados em solicitações anteriores por meio desta API permanecem válidos.
AuthType	String	No	secret	Método de autenticação usado para conectar os dispositivos do produto ao IoT Platform. Não especifique este parâmetro. O sistema aplica automaticamente o valor padrão secret. Para mais informações, consulte Estabelecer conexões MQTT sobre TCP.
CategoryKey	String	No	Lighting	Identificador da categoria do produto. Ao especificar este parâmetro, o sistema utiliza um modelo TSL da categoria correspondente. Caso contrário, nenhum modelo TSL será aplicado. Chame a operação ListThingTemplates para consultar os detalhes das categorias de produtos predefinidas pelo IoT Platform e obter as chaves de categoria.
PublishAuto	Boolean	No	false	Define se o modelo TSL deve ser publicado após a criação do produto. Valores válidos: true false Valor padrão: true.
ValidateType	Integer	No	1	Nível de verificação dos dados. Por padrão, se você não especificar este parâmetro, o sistema aplica a verificação fraca. Valores válidos: 1: verificação fraca. O IoT Platform valida apenas os campos identifier e dataType dos dados. Todos os dados são encaminhados. No console do IoT Platform, os dados aparecem na aba TSL Data da página Device Details. Dados que falham na verificação não são exibidos. É possível visualizar os dados reprovados na verificação por meio do parâmetro checkFailedData nos dados encaminhados. Para mais informações, consulte Formatos de dados. 2: sem verificação. O IoT Platform não valida os dados. Todo o tráfego é encaminhado. No console do IoT Platform, os dados não aparecem na aba TSL Data da página Device Details.

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

Parâmetros de resposta

Parameter	Type	Example	Description
Code	String	200	Código de erro retornado caso a solicitação falhe. Para mais informações, consulte Códigos de erro.
Data	Struct		Informações do produto retornadas em caso de sucesso na solicitação.
AliyunCommodityCode	String	iothub_senior	Indica se o produto usa um modelo TSL. Valores válidos: iothub_senior: usa modelo TSL. iothub: não usa modelo TSL.
AuthType	String	secret	Método de autenticação usado para conectar os dispositivos do produto ao IoT Platform.
DataFormat	Integer	1	Formato dos dados. Valores válidos: 0: formato de dados personalizado. 1: formato Alink JSON. Nota Este parâmetro só é retornado quando AliyunCommodityCode estiver definido como iothub_senior.
Description	String	Product test	Descrição do produto.
Id2	Boolean	false	Indica se a autenticação baseada em ID² está ativada. Valores válidos: true false
NodeType	Integer	0	Tipo de nó do produto. 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. Subdispositivos podem ser anexados a um gateway. O gateway gerencia subdispositivos, mantém relacionamentos topológicos com eles e sincroniza esses relacionamentos com o IoT Platform. Nota Este parâmetro só é retornado quando AliyunCommodityCode estiver definido como iothub_senior.
ProductKey	String	a1FlqIQ****	ProductKey do produto. Trata-se de um GUID emitido pelo IoT Platform para identificar o produto. Nota Mantenha a ProductKey em sigilo. A ProductKey é necessária para executar determinadas operações.
ProductName	String	Test	Nome do produto.
ProductSecret	String	U5tW7i44uilc****	ProductSecret do produto.
ProtocolType	String	modbus	Protocolo usado pelos dispositivos do produto para se conectar ao gateway. Nota Este parâmetro só é retornado quando AliyunCommodityCode estiver definido como iothub_senior.
ErrorMessage	String	A system exception occurred.	Mensagem de erro retornada caso a solicitação falhe.
ProductKey	String	a1FlqIQ****	ProductKey do produto. Uma ProductKey é um GUID emitido pelo IoT Platform para identificar o produto.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	ID da solicitação.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida. Valores válidos: true false

Exemplos

Exemplo de solicitação

https://iot.cn-shanghai.aliyuncs.com/?Action=CreateProduct
&AliyunCommodityCode=iothub_senior
&AuthType=secret
&DataFormat=1
&Description=Product test
&NodeType=0
&ResourceGroupId=rg-acfmxazb4ph****
&ProductName=Test
&ProtocolType=modbus
&CategoryKey=Lighting
&PublishAuto=false
&<Common request parameters>

Exemplo de resposta de sucesso

Formato XML

<CreateProductResponse>
      <Data>
            <Description>Product test</Description>
            <DataFormat>1</DataFormat>
            <ProtocolType>modbus</ProtocolType>
            <ProductKey>a1FlqIQ****</ProductKey>
            <ProductSecret>U5tW7i44uilc****</ProductSecret>
            <NodeType>0</NodeType>
            <ProductName>Test</ProductName>
            <AliyunCommodityCode>iothub_senior</AliyunCommodityCode>
            <AuthType>secret</AuthType>
            <ResourceGroupId>rg-acfmxazb4ph****</ResourceGroupId>
      </Data>
      <ProductKey>a1FlqIQ****</ProductKey>
      <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
      <Success>true</Success>
</CreateProductResponse>

Formato JSON

{
  "Data": {
    "Description": "Product test",
    "DataFormat": 1,
    "ProtocolType": "modbus",
    "ProductKey": "a1FlqIQ****",
    "ProductSecret": "U5tW7i44uilc****",
    "NodeType": 0,
    "ProductName": "Test",
    "AliyunCommodityCode": "iothub_senior",
    "AuthType": "secret",
    "ResourceGroupId": "rg-acfmxazb4ph****"
  },
  "ProductKey": "a1FlqIQ****",
  "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
  "Success": true
}

Códigos de erro

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