Crea varios DeviceName personalizados bajo un producto. IoT Platform comprueba la validez de los DeviceName.
Notas de uso
Debe utilizar esta operación junto con la operación BatchRegisterDeviceWithApplyId para registrar varios dispositivos con nombres únicos bajo un mismo producto.
Procedimiento:
Llame a la operación BatchCheckDeviceNames para especificar los nombres de los dispositivos que desea registrar. IoT Platform devuelve el ID de solicitud indicado por el parámetro ApplyId. Si la llamada es exitosa, se envía una solicitud para verificar los DeviceName. La verificación real se realiza de forma asíncrona.
Llame a la operación QueryBatchRegisterDeviceStatus para consultar el resultado de la configuración de nombres.
Llame a la operación BatchRegisterDeviceWithApplyId para registrar los dispositivos.
Opcional. Llame a la operación QueryBatchRegisterDeviceStatus para consultar el resultado del registro de dispositivos.
Llame a la operación QueryPageByApplyId para consultar los detalles de los dispositivos registrados simultáneamente.
Límites
Puede especificar hasta 10,000 DeviceName en una sola llamada.
Límites de QPS
Puede llamar a esta operación de API hasta 10 veces por segundo por cuenta.
Los usuarios RAM de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.
Depuración
Parámetros de solicitud
Parámetro | Tipo | Obligatorio | Ejemplo | Descripción |
Action | String | Sí | BatchCheckDeviceNames | La operación que desea realizar. Establezca el valor en BatchCheckDeviceNames. |
ProductKey | String | Sí | a1BwAGV**** | El ProductKey del producto al que pertenece el dispositivo. |
IotInstanceId | String | No | iot-cn-0pp1n8t**** | El ID de la instancia de IoT. Puede consultar el ID de la instancia en la página Overview de la consola de IoT Platform. Importante
Para obtener más información, consulte el tema Descripción general de instancias de IoT. |
DeviceName.N | RepeatList | No | light | El nombre del dispositivo. El DeviceName debe ser único dentro del producto. Debe tener entre 4 y 32 caracteres de longitud y puede contener letras, dígitos, guiones (-), guiones bajos (_), arrobas (@), puntos (.) y dos puntos (:). Debe especificar este parámetro o el parámetro DeviceNameList.N.DeviceName. Si especifica ambos al mismo tiempo, el valor del parámetro DeviceNameList.N.DeviceName tendrá prioridad. Nota Puede especificar hasta 10,000 DeviceName en una sola llamada. Si la cantidad de DeviceName supera el límite, los nombres excedentes se descartarán. |
DeviceNameList.N.DeviceName | String | No | light1 | El nombre del dispositivo. El DeviceName debe ser único dentro del producto. Debe tener entre 4 y 32 caracteres de longitud y puede contener letras, dígitos, guiones (-), guiones bajos (_), arrobas (@), puntos (.) y dos puntos (:). Debe especificar este parámetro o el parámetro DeviceName.N. Si especifica ambos al mismo tiempo, el valor de este parámetro tendrá prioridad. Nota Puede especificar hasta 10,000 DeviceName en una sola llamada. Si la cantidad de DeviceName supera el límite, los nombres excedentes se descartarán. |
DeviceNameList.N.DeviceNickname | String | No | Smart light 1 | El alias del dispositivo. El alias debe tener entre 4 y 64 caracteres de longitud y puede contener letras, dígitos y guiones bajos (_). Importante Si especifica este parámetro, también debe especificar el parámetro DeviceNameList.N.DeviceName. |
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 sobre los parámetros de solicitud comunes, 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 fue exitosa. | |
ApplyId | Long | 1295006 | El ID de solicitud (ApplyId) devuelto si la llamada fue exitosa. Al llamar a la operación BatchRegisterDeviceWithApplyId para registrar dispositivos, debe especificar el parámetro ApplyId. |
InvalidDetailList | Array of InvalidDetailList | Los detalles de los DeviceName no válidos de los dispositivos cuyo registro falló. | |
InvalidDetailList | |||
DeviceName | String | light | El DeviceName. |
ErrorMsg | String | The device name is illegal. | Los mensajes de error devueltos cuando falla el registro de los dispositivos. Nota Varios mensajes de error se separan mediante barras verticales (|). |
NickName | String | Smart Light 1 | El alias del dispositivo. |
InvalidDeviceNameList | List | { "InvalidDeviceName": [ "APT$", "aw" ] } | Los DeviceName no válidos cuyo registro falló. |
InvalidDeviceNicknameList | List | { "InvalidDeviceNickname": [ "APT$", "aw" ] } | Los alias de dispositivo no válidos cuyo registro falló. |
RepeatedDeviceNameList | List | { "RepeatedDeviceName": [ "APT$", "aw" ] } | Los DeviceName duplicados cuyo registro falló. |
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 solicitud fue exitosa. Valores válidos:
|
Ejemplos
Solicitudes de ejemplo
https://iot.cn-shanghai.aliyuncs.com/?Action=BatchCheckDeviceNames
&productKey=a1BwAGV****
&DeviceNameList.1.DeviceName=light1
&DeviceNameList.2.DeviceName=light2
&DeviceNameList.3.DeviceName=light3
&DeviceNameList.3.DeviceNickname=Smart light 3
&<Common request parameters>Respuestas exitosas de ejemplo
Formato XML
<BatchCheckDeviceNamesResponse>
<Data>
<ApplyId>1234567</ApplyId>
</Data>
<RequestId>E976E36B-6874-4FA4-8BC0-55F9BEC5E2EF</RequestId>
<Success>true</Success>
</BatchCheckDeviceNamesResponse>Formato JSON
{
"Data": {
"ApplyId": 1234567
},
"RequestId": "E976E36B-6874-4FA4-8BC0-55F9BEC5E2EF",
"Success": true
}Códigos de error
Para obtener una lista de códigos de error, consulte Códigos de error del servicio.