RegisterDevice - IoT Platform - Centro de documentación de Alibaba Cloud

Registra un dispositivo en un producto.

Notas de uso

Si llama a esta operación para registrar un dispositivo en un producto, el dispositivo se agrega al producto en la consola de IoT Platform. Una vez registrado el dispositivo, IoT Platform emite el parámetro IotId para dicho dispositivo. Este parámetro es un identificador único global (GUID) del dispositivo. Para operar un dispositivo, debe usar el parámetro IotId para identificarlo.

También puede usar una combinación de los parámetros ProductKey y DeviceName para identificar un dispositivo. IoT Platform emite un ProductKey para un producto cuando usted crea dicho producto. El DeviceName se especifica o se genera aleatoriamente al crear un dispositivo. El parámetro IotId tiene mayor prioridad que la combinación de los parámetros ProductKey y DeviceName.

Para obtener información sobre cómo registrar varios dispositivos en un producto simultáneamente, consulte BatchRegisterDeviceWithApplyId.

Límites

Cada cuenta de Alibaba Cloud puede ejecutar un máximo de 30 consultas por segundo (QPS).

Nota

Los usuarios RAM de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.

Depuración

Alibaba Cloud proporciona OpenAPI Explorer para simplificar el uso de la API. OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, se recomienda llamar a esta operación desde OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	RegisterDevice	La operación que desea ejecutar. Establezca el valor en RegisterDevice.
ProductKey	String	Sí	a1BwAGV****	El ProductKey del producto al que pertenece el dispositivo. Un ProductKey es un GUID que IoT Platform emite para un producto. Puede usar la consola de IoT Platform o llamar a la operación QueryProductList para consultar la información de todos los productos en la cuenta actual.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	El ID de la instancia. Puede consultar el ID de la instancia en la página Overview de la consola de IoT Platform. Importante Si su instancia tiene un ID, debe configurar este parámetro. Si no establece este parámetro, la llamada fallará. Si su instancia no tiene página Overview ni ID, no necesita establecer este parámetro. Para obtener más información, consulte Overview.
DeviceName	String	No	light	El DeviceName del dispositivo. El nombre debe tener entre 4 y 32 caracteres, y puede contener letras, dígitos, guiones (-), guiones bajos (_), arrobas (@), puntos (.) y dos puntos (:). Puede usar una combinación de los parámetros DeviceName y ProductKey para identificar un dispositivo. Nota Si no especifica este parámetro, IoT Platform genera un DeviceName aleatorio.
DevEui	String	No	e8SDdgeIlk3nED****	El DevEUI del dispositivo LoRaWAN. Este parámetro es obligatorio al crear un dispositivo LoRaWAN.
Nickname	String	No	Campus light	El alias del dispositivo. El alias debe tener entre 4 y 64 caracteres, y puede contener letras, dígitos y guiones bajos (_). Nota Si no especifica este parámetro, IoT Platform no genera un alias para el dispositivo.
PinCode	String	No	DIe80dfeg*****	El código PIN del dispositivo LoRaWAN. Este parámetro se usa para verificar el DevEUI. Al crear un dispositivo LoRaWAN, establezca LoraNodeType en ALIYUNDEFINED. Este parámetro es obligatorio.
JoinEui	String	No	Ede4tde8erth****	El JoinEUI del dispositivo LoRaWAN. Al crear un dispositivo LoRaWAN, establezca LoraNodeType en USERDEFINED. Este parámetro es obligatorio.
AppKey	String	No	674f***	El AppKey del dispositivo LoRaWAN. Al crear un dispositivo LoRaWAN, establezca LoraNodeType en USERDEFINED. Este parámetro es obligatorio.
LoraNodeType	String	No	ALIYUNDEFINED	El tipo de dispositivo LoRaWAN. Valores válidos: ALIYUNDEFINED: El dispositivo lo emite Alibaba Cloud. Debe especificar DevEui y PinCode. USERDEFINED: El dispositivo está definido por el usuario. Debe especificar DevEui, JoinEui y AppKey.

Además de los parámetros de solicitud específicos de la operación mencionados anteriormente, debe especificar los parámetros de solicitud comunes al llamar a esta operación. Para obtener más información, consulte Parámetros de solicitud comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	El código de error devuelto si la llamada falla. Para obtener más información, consulte Códigos de error.
Data	Struct		La información del dispositivo devuelta si la llamada es exitosa.
DevEui	String	e8SDdgeIlk3nED****	El DevEUI del dispositivo LoRaWAN. Este parámetro se devuelve solo al crear un dispositivo LoRaWAN.
DeviceName	String	light	El DeviceName del dispositivo. Importante Mantenga esta información confidencial.
DeviceSecret	String	mz2Canp4GB7qRVf1OYPNtRqB2anu****	El DeviceSecret del dispositivo. Importante Mantenga esta información confidencial.
IotId	String	1O4YPNtRqB2anumz2Canp4GB7q****	El ID del dispositivo. Es el identificador único que IoT Platform emite para el dispositivo. Importante Mantenga esta información confidencial.
JoinEui	String	Ede4tde8erth****	El JoinEUI del dispositivo LoRaWAN. Este parámetro se devuelve solo al crear un dispositivo LoRaWAN.
Nickname	String	Campus light	El alias del dispositivo. Si no especifica un alias para el dispositivo, este parámetro estará vacío.
ProductKey	String	a1BwAGV****	El ProductKey del producto al que pertenece el dispositivo.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la llamada falla.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	El ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. true: La llamada fue exitosa. false: La llamada falló.

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

XML formato

<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>

JSON formato

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

Códigos de error

Para obtener una lista de códigos de error, visite el Centro de errores de API.