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

Registra um dispositivo em um produto.

Observações de uso

Ao chamar esta operação para registrar um dispositivo em um produto, o sistema adiciona o dispositivo ao produto no console do IoT Platform. Após o registro, o IoT Platform emite o parâmetro IotId para o dispositivo. Esse parâmetro é o identificador globalmente exclusivo (GUID) do dispositivo. Para executar operações em um dispositivo, use o parâmetro IotId para identificá-lo.

Também é possível usar a combinação dos parâmetros ProductKey e DeviceName para identificar um dispositivo. O IoT Platform emite o ProductKey para um produto durante a criação. O DeviceName é especificado ou gerado aleatoriamente durante a criação do dispositivo. O parâmetro IotId tem prioridade sobre a combinação dos parâmetros ProductKey e DeviceName.

Para registrar vários dispositivos em um produto simultaneamente, consulte BatchRegisterDeviceWithApplyId.

Limites

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

Nota

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

Depuração

A 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. A ferramenta gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	RegisterDevice	A operação a ser executada. Defina o valor como RegisterDevice.
ProductKey	String	Sim	a1BwAGV****	O ProductKey do produto ao qual o dispositivo pertence. O ProductKey é um GUID que o IoT Platform emite para um produto. Use o console do IoT Platform ou chame a operação QueryProductList para visualizar as informações de 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 a instância tiver 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 defina este parâmetro. Para mais informações, consulte Overview.
DeviceName	String	Não	light	O DeviceName do dispositivo. O nome deve ter de 4 a 32 caracteres e pode conter letras, dígitos, hifens (-), sublinhados (_), arrobas (@), pontos (.) e dois-pontos (:). Use a combinação dos parâmetros DeviceName e ProductKey para identificar um dispositivo. Nota Se você não especificar este parâmetro, o IoT Platform gerará um DeviceName aleatoriamente.
DevEui	String	Não	e8SDdgeIlk3nED****	O DevEUI do dispositivo LoRaWAN. Este parâmetro é obrigatório ao criar um dispositivo LoRaWAN.
Nickname	String	Não	Campus light	O alias do dispositivo. O alias deve ter de 4 a 64 caracteres e pode conter letras, dígitos e sublinhados (_). Nota Se você não especificar este parâmetro, o IoT Platform não gerará um alias para o dispositivo.
PinCode	String	Não	DIe80dfeg*****	O código PIN do dispositivo LoRaWAN. Este parâmetro verifica o DevEUI. Ao criar um dispositivo LoRaWAN, defina LoraNodeType como ALIYUNDEFINED. Este parâmetro é obrigatório.
JoinEui	String	Não	Ede4tde8erth****	O JoinEUI do dispositivo LoRaWAN. Ao criar um dispositivo LoRaWAN, defina LoraNodeType como USERDEFINED. Este parâmetro é obrigatório.
AppKey	String	Não	674f***	A AppKey do dispositivo LoRaWAN. Ao criar um dispositivo LoRaWAN, defina LoraNodeType como USERDEFINED. Este parâmetro é obrigatório.
LoraNodeType	String	Não	ALIYUNDEFINED	O tipo do dispositivo LoRaWAN. Valores válidos: ALIYUNDEFINED: dispositivo emitido pela Alibaba Cloud. Especifique DevEui e PinCode. USERDEFINED: dispositivo definido pelo usuário. Especifique DevEui, JoinEui e AppKey.

Além dos parâmetros 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
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 dispositivo retornadas se a chamada for bem-sucedida.
DevEui	String	e8SDdgeIlk3nED****	O DevEUI do dispositivo LoRaWAN. Este parâmetro é retornado apenas ao criar um dispositivo LoRaWAN.
DeviceName	String	light	O DeviceName do dispositivo. Importante Mantenha essas informações confidenciais.
DeviceSecret	String	mz2Canp4GB7qRVf1OYPNtRqB2anu****	O DeviceSecret do dispositivo. Importante Mantenha essas informações confidenciais.
IotId	String	1O4YPNtRqB2anumz2Canp4GB7q****	O ID do dispositivo. Trata-se do identificador exclusivo que o IoT Platform emite para o dispositivo. Importante Mantenha essas informações confidenciais.
JoinEui	String	Ede4tde8erth****	O JoinEUI do dispositivo LoRaWAN. Este parâmetro é retornado apenas ao criar um dispositivo LoRaWAN.
Nickname	String	Campus light	O alias do dispositivo. Se nenhum alias for especificado para o dispositivo, este parâmetro estará vazio.
ProductKey	String	a1BwAGV****	O ProductKey do produto ao qual o dispositivo pertence.
ErrorMessage	String	A system exception occurred.	A mensagem de erro retornada se a chamada falhar.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	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

Solicitações de exemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=RegisterDevice
&ProductKey=a1rYuVF****
&DeviceName=device1
&Nickname=detectors_in_beijing
&<Common request parameters>

Respostas de sucesso de exemplo

Formato XML

<RegisterDeviceResponse>
  <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
  <Success>true</Success>
  <Data>
        <DeviceName>device1</DeviceName>
        <ProductKey>a1rYuVF****</ProductKey>
        <DeviceSecret>tXHf4ezGEHcwdyMwoCDHGBmk9avi****</DeviceSecret>
        <IotId>CqXL5h5ysRTA4NxjABjj0010fa****</IotId>
        <Nickname>detectors_in_beijing</Nickname>
  </Data>
</RegisterDeviceResponse>

Formato JSON

{
    "RequestId": "57b144cf-09fc-4916-a272-a62902d5b207", 
    "Success": true, 
    "Data": {
        "DeviceName": "device1", 
        "ProductKey": "a1rYuVF****", 
        "DeviceSecret": "tXHf4ezGEHcwdyMwoCDHGBmk9avi****", 
        "IotId": "CqXL5h5ysRTA4NxjABjj0010fa****", 
        "Nickname": "detectors_in_beijing"
    }
}

Códigos de erro

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