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

Importa un dispositivo a un producto de puerta de enlace MQTT.

Notas de uso

Antes de llamar a esta operación, asegúrese de haber creado una puerta de enlace MQTT y el producto relacionado, y de haber obtenido la ProductKey del producto.

Límites de QPS

Esta operación de API admite hasta 50 llamadas por segundo por cuenta.

Nota

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

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, se recomienda llamar a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDKs.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ImportDevice	La operación que desea ejecutar. Establezca el valor en ImportDevice.
ProductKey	String	Sí	a1BwAGV****	La ProductKey del producto al que pertenece el dispositivo.
DeviceName	String	Sí	light	El DeviceName del dispositivo. El DeviceName debe tener entre 4 y 32 caracteres de longitud, y puede contener letras, dígitos, guiones (-), guiones bajos (_), arrobas (@), puntos (.) y dos puntos (:). El DeviceName debe ser único dentro del producto.
DeviceSecret	String	Sí	b4d43f7******10ba5e5	El DeviceSecret del dispositivo. El DeviceSecret debe tener entre 1 y 32 caracteres de longitud, y puede contener letras, dígitos, guiones (-), guiones bajos (_), arrobas (@), puntos (.) y dos puntos (:).
Nickname	String	No	Campus light	El alias del dispositivo. El alias debe tener entre 1 y 64 caracteres de longitud, 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.
Sn	String	No	QC4******001	El número de serie (SN) del dispositivo. El SN debe tener entre 1 y 64 caracteres de longitud, y puede contener letras, dígitos y guiones bajos (_). Nota Si no especifica este parámetro, IoT Platform no genera un SN para el dispositivo.
IotInstanceId	String	No	iot-1n8t****	El ID de la instancia. Puede encontrar el ID en la página de Overview en la consola de IoT Platform. Importante Si su instancia tiene un ID, debe especificarlo; de lo contrario, la llamada fallará. Si no se ha generado ninguna página de Overview o ID para su instancia, no es necesario especificar este parámetro. Para obtener más información, consulte Descripción general.

Además de los parámetros específicos de la operación, debe especificar los parámetros de solicitud comunes al llamar a esta operación. Para obtener más información, consulte Parámetros 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 cuando la llamada es exitosa.
DeviceName	String	light	El DeviceName del dispositivo. Importante Mantenga esta información confidencial.
DeviceSecret	String	b4d43f7******10ba5e5	El DeviceSecret del dispositivo. Importante Mantenga esta información confidencial.
IotId	String	1O4YPNtRqB2anumz2Canp4GB7*****	El ID único del dispositivo emitido por IoT Platform. Importante Mantenga esta información confidencial.
Nickname	String	Campus light	El alias del dispositivo. Nota Si no especifica un alias para el dispositivo, este parámetro estará vacío.
ProductKey	String	a1BwAGV****	La ProductKey del producto al que pertenece el dispositivo.
Sn	String	QC4******001	El SN del dispositivo. Nota Si no especifica un SN para el dispositivo, este parámetro estará vacío.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la llamada falla.
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	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

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ImportDevice
&DeviceName=device1
&DeviceSecret=b4d43f7******10ba5e5
&ProductKey=a1BwAGV****
&IotInstanceId=iot-1n8t****
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<ImportDeviceResponse>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Data>
        <IotId>1O4YPNtRqB2anumz2Canp4GB7*****</IotId>
        <DeviceSecret>b4d43f7******10ba5e5</DeviceSecret>
        <Sn>QC4******001</Sn>
        <ProductKey>a1BwAGV****</ProductKey>
        <Nickname>Campus light</Nickname>
        <DeviceName>light</DeviceName>
  </Data>
  <Success>true</Success>
</ImportDeviceResponse>

Formato JSON

{
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Data": {
        "IotId": "1O4YPNtRqB2anumz2Canp4GB7*****",
        "DeviceSecret": "b4d43f7******10ba5e5",
        "Sn": "QC4******001",
        "ProductKey": "a1BwAGV****",
        "Nickname": "Campus light",
        "DeviceName": "light"
    },
    "Success": true
}

Códigos de error

HttpCode	Código de error	Mensaje de error	Descripción
200	iot.device.CreateDeviceFailed	An error occurred while creating the device.	El sistema no pudo crear el dispositivo.
200	iot.device.AlreadyExistedDeviceName	The DeviceName already exists.	El DeviceName especificado ya existe en el producto.

Para consultar una lista de códigos de error, visite Códigos de error del servicio.