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

Importa varios dispositivos en una instancia Standard o en un producto de puerta de enlace MQTT en un solo lote.

Notas de uso

Antes de agregar dispositivos a un producto de puerta de enlace MQTT, cree una puerta de enlace MQTT y el producto relacionado, y obtenga la ProductKey. Para obtener más información, consulte Crear una puerta de enlace MQTT.

Límites de QPS

Puede llamar a esta operación de API hasta 10 veces por segundo por cuenta.

Nota

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

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

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	BatchImportDevice	La operación que desea ejecutar. Establezca el valor en BatchImportDevice.
ProductKey	String	Sí	a1BwAGV****	La ProductKey del producto al que pertenece el dispositivo. Una ProductKey es el identificador único de un producto en IoT Platform. Puede consultar los productos en la consola de IoT Platform o mediante la operación QueryProductList.
DeviceList.N.DeviceName	String	Sí	device1	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. Nota Puede especificar hasta 10,000 DeviceNames en una sola llamada. Si la cantidad de DeviceNames supera el límite, los DeviceNames excedentes se descartan.
DeviceList.N.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 (:). Nota Puede especificar hasta 10,000 DeviceSecrets en una sola llamada. Si la cantidad de DeviceSecrets supera el límite, los DeviceSecrets excedentes se descartan.
DeviceList.N.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 Puede especificar hasta 10,000 SN en una sola llamada. Si la cantidad de SN supera el límite, los SN excedentes se descartan.
IotInstanceId	String	No	iot-1n8t****	El ID de la instancia. Puede encontrar el ID en la página Overview de la consola de IoT Platform. Importante Si su instancia tiene un ID, debe especificar el ID para este parámetro. De lo contrario, la llamada falla. Si no se genera ninguna página Overview ni ID para su instancia, no necesita configurar 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 listados anteriormente, tambié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		Los datos devueltos si la llamada es exitosa.
ApplyId	Long	1295006	El ID de solicitud (ApplyId) generado para una solicitud exitosa.
InvalidDetailList	Array of InvalidDetailList		Los detalles de los dispositivos no válidos devueltos si la llamada falla.
InvalidDetailList
DeviceName	String	light%	El DeviceName del dispositivo.
DeviceSecret	String	^67$	El DeviceSecret del dispositivo.
ErrorMsg	String	The device name is illegal.	El mensaje de error devuelto si la llamada falla.
Sn	String	QC4001#	El SN del dispositivo.
InvalidDeviceNameList	List	{ "InvalidDeviceNameList": [ "APT$", "aw" ] }	Los DeviceNames de los dispositivos no válidos devueltos si la llamada falla.
InvalidDeviceSecretList	List	{ "InvalidDeviceSecretList": [ "^67$", "1" ] }	Los DeviceSecrets de los dispositivos no válidos devueltos si la llamada falla.
InvalidSnList	List	{ "InvalidSnList": [ "" ] }	Los SN de los dispositivos no válidos devueltos si la llamada falla.
RepeatedDeviceNameList	List	{ "RepeatedDeviceNameList": [ "abcd", "asdf" ] }	Los DeviceNames duplicados devueltos si la llamada falla.
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. Valores válidos: true: La llamada fue exitosa. false: La llamada falló.

Descripción

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

Formato XML

<BatchImportDeviceResponse>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Data>
        <ApplyId>1295006</ApplyId>
  </Data>
  <Success>true</Success>
</BatchImportDeviceResponse>

Formato JSON

{
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Data": {
        "ApplyId": 1295006
    },
    "Success": true
}

Códigos de error

HttpCode	Código de error	Mensaje de error	Descripción
400	iot.device.TooManyDeviceNamesPerRequest	The devices you query exceed the maximum number.	La cantidad de DeviceNames especificada en la solicitud supera el límite.
400	iot.device.ApplyManyDevicesFailed	An error occurred while creating multiple devices.	El sistema no pudo crear varios dispositivos a la vez.
400	iot.device.DeviceNumerExceedTenant	The device total number beyond limit.	La cantidad de dispositivos supera el límite.

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.