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

Verifica en lote los dispositivos importados a una instancia de Enterprise Edition estándar o a un producto de puerta de enlace en la nube MQTT.

Límites de QPS

Puede llamar a esta operación hasta 100 veces por segundo por cuenta.

Nota

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

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos que llame 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	Detalles
Action	String	Sí	BatchCheckImportDevice	La operación que desea ejecutar. Establezca el valor en BatchCheckImportDevice.
ProductKey	String	Sí	a1BwAGV****	El ProductKey del producto al que pertenecen los dispositivos.
DeviceList.N.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. Nota Puede especificar hasta 10,000 DeviceNames en una sola llamada. Si la cantidad de DeviceNames supera el límite, se descartarán los excedentes.
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, se descartarán los excedentes.
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 SNs en una sola llamada. Si la cantidad de SNs supera el límite, se descartarán los excedentes.
IotInstanceId	String	No	iot-1n8t****	El ID de la instancia. Puede encontrar el ID en la pestaña Descripción general de la consola de IoT Platform. Importante Si su instancia tiene un ID, debe especificarlo en este parámetro. De lo contrario, la llamada fallará. Si no se generó ninguna pestaña Descripción general ni ID para su instancia, no necesita configurar este parámetro. Para obtener más información, consulte Instance overview.

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 Common parameters.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Detalles
Code	String	iot.system.SystemException	El código de error devuelto si la llamada falla. Para obtener más información, consulte Error codes.
Data	Struct		Los datos devueltos si la llamada es exitosa, incluida la información sobre los dispositivos cuya verificación falló.
InvalidDetailList	Array of InvalidDetailList		Los dispositivos no válidos.
DeviceName	String	light%	El DeviceName del dispositivo.
DeviceSecret	String	^67$	El secreto 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 no válidos.
InvalidDeviceSecretList	List	{ "InvalidDeviceSecretList": [ "^67$", "1" ] }	Los DeviceSecrets no válidos.
InvalidSnList	List	{ "InvalidSnList": [ "" ] }	Los SN de dispositivo no válidos.
RepeatedDeviceNameList	List	{ "RepeatedDeviceNameList": [ "abcd", "asdf" ] }	Los DeviceNames duplicados.
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ó.

Ejemplos

Solicitudes de ejemplo

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=BatchCheckImportDevice
&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

<BatchCheckImportDeviceResponse>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Success>true</Success>
</BatchCheckImportDeviceResponse>

Formato JSON

{
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "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 especificados en la solicitud supera el límite.
400	iot.device.NoneDeviceNameElement	The DeviceName list is empty.	No se especificaron DeviceNames.
400	iot.device.InvalidDeviceParams	The request parameters are invalid.	El valor del parámetro de solicitud no es válido.

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