Agrega varios dispositivos a un producto de puerta de enlace en la nube de forma simultánea.
Notas de uso
La operación BatchImportVehicleDevice es adecuada para escenarios en los que se requiere agregar varios dispositivos a un producto de puerta de enlace en la nube JT/T 808 o GB/T 32960 al mismo tiempo.
Límites de QPS
Puede invocar esta API hasta 10 veces por segundo por cuenta.
Los usuarios de 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í | BatchImportVehicleDevice | La operación que desea ejecutar. Establezca el valor en BatchImportVehicleDevice. |
| IotInstanceId | String | Sí | iot-1n8t**** | El ID de la instancia. Puede consultar el ID de la instancia en la pestaña Descripción general de la consola de IoT Platform. Para obtener más información, consulte Descripción general. |
| ProductKey | String | Sí | a1Bw**** | La clave ProductKey del producto al que pertenece el dispositivo. |
| DeviceList.N.Manufacturer | String | No | mf0001 | El ID del fabricante del dispositivo. Si desea agregar un dispositivo de puerta de enlace en la nube JT/T 808, este parámetro es obligatorio. El ID del fabricante debe tener entre 4 y 11 caracteres, y puede contener letras, dígitos y guiones (-). Nota Puede especificar hasta 10,000 ID de fabricante de dispositivos en una sola llamada. Si la cantidad de ID de fabricante supera el límite, los ID excedentes se descartan. |
| DeviceList.N.DeviceModel | String | No | dm0001 | El modelo del dispositivo. Si desea agregar un dispositivo de puerta de enlace en la nube JT/T 808, este parámetro es obligatorio. El modelo del dispositivo debe tener entre 4 y 30 caracteres, y puede contener letras, dígitos y guiones (-). Nota Puede especificar hasta 10,000 modelos de dispositivo en una sola llamada. Si la cantidad de modelos supera el límite, los modelos excedentes se descartan. |
| DeviceList.N.DeviceId | String | No | di0001 | El ID del dispositivo. Si desea agregar un dispositivo de puerta de enlace en la nube JT/T 808, este parámetro es obligatorio. El ID debe tener entre 4 y 30 caracteres, y puede contener letras, dígitos y guiones (-). Nota Puede especificar hasta 10,000 ID de dispositivo en una sola llamada. Si la cantidad de ID supera el límite, los ID excedentes se descartan. |
| DeviceList.N.DeviceName | String | No | vin0001 | El DeviceName del dispositivo. Si desea agregar un dispositivo de puerta de enlace en la nube JT/T 808, debe especificar el número de identificación vehicular (VIN) del dispositivo como valor de este parámetro. El DeviceName debe tener entre 4 y 17 caracteres, y puede contener letras y dígitos. 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. |
Además de los parámetros de solicitud específicos de la operación mencionados anteriormente, debe configurar los parámetros de solicitud comunes al invocar esta operación. Para obtener más información sobre los parámetros de solicitud comunes, consulte Common parameters.
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 la sección "Códigos de error" de este tema. |
| Data | Struct | Los datos devueltos si la llamada es exitosa. |
|
| ApplyId | Long | 1295006 | El ID de solicitud (ApplyId) devuelto si la llamada es exitosa. |
| InvalidDetailList | Array of InvalidDetailList | Los detalles de los dispositivos no válidos devueltos si la llamada falla. |
|
| InvalidDetailList | |||
| DeviceId | String | di_*0001 | Los ID de los dispositivos de puerta de enlace en la nube JT/T 808. |
| DeviceModel | String | dm_*0001 | Los modelos de los dispositivos de puerta de enlace en la nube JT/T 808. |
| DeviceName | String | device_*0001 | Los DeviceNames de los dispositivos de puerta de enlace en la nube GB/T 32960. |
| ErrorMsg | String | The device name is illegal. | El mensaje de error devuelto si la llamada falla. |
| Manufacturer | String | mf_*0001 | Los ID de fabricante de los dispositivos de puerta de enlace en la nube JT/T 808. |
| InvalidDeviceIdList | List | { "InvalidDeviceIdList": [ "di&^", "&*G%" ] } | Los ID de dispositivo no válidos devueltos si no se pudieron agregar los dispositivos de puerta de enlace en la nube JT/T 808. |
| InvalidDeviceModelList | List | { "InvalidDeviceModelList": [ "dm$", "dm_uh" ] } | Los modelos de dispositivo no válidos devueltos si no se pudieron agregar los dispositivos de puerta de enlace en la nube JT/T 808. |
| InvalidDeviceNameList | List | { "InvalidDeviceNameList": [ "APT$", "aw" ] } | Los DeviceNames no válidos devueltos si no se pudieron agregar los dispositivos de puerta de enlace en la nube GB/T 32960. |
| InvalidManufacturerList | List | { "InvalidManufacturerList": [ "bm*$", "#$F" ] } | Los ID de fabricante no válidos devueltos si no se pudieron agregar los dispositivos de puerta de enlace en la nube JT/T 808. |
| RepeatedDeviceIdList | List | { "RepeatedDeviceIdList": [ "^67$", "1" ] } | Los ID de dispositivo duplicados devueltos si no se pudieron agregar los dispositivos de puerta de enlace en la nube JT/T 808. |
| RepeatedDeviceNameList | List | { "RepeatedDeviceNameList": [ "abcd", "asdf" ] } | Los DeviceNames duplicados devueltos si no se pudieron agregar los dispositivos de puerta de enlace en la nube GB/T 32960. |
| 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:
|
Ejemplos
Solicitudes de ejemplo
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=BatchImportVehicleDevice
&DeviceList.1.DeviceModel=dm0001
&DeviceList.1.Manufacturer=mf0001
&DeviceList.1.DeviceId=di0001
&ProductKey=a1Bw****
&IotInstanceId=iot-cv3********
&<Common request parameters>Respuestas exitosas de ejemplo
Formato XML
<BatchImportVehicleDeviceResponse>
<RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
<Data>
<ApplyId>1295006</ApplyId>
</Data>
<Code></Code>
<Success>true</Success>
</BatchImportVehicleDeviceResponse>Formato JSON
{
"RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
"Data": {
"ApplyId": 1295006
},
"Code": "",
"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. |
Falló la solicitud para crear varios dispositivos simultáneamente. |
|
400 |
iot.common.InvalidTenant |
the device tenantId is invalid. |
La información del inquilino del dispositivo no es válida. |
|
400 |
iot.device.InvalidFormattedDeviceNameInNameArray |
The DeviceName list contains an invalid DeviceName. |
Existe un DeviceName no válido en la lista de DeviceNames. |
|
400 |
iot.prod.InvalidProductAuthType |
The product authentication type is invalid. |
El tipo de autenticación del producto no es válido. |
|
400 |
iot.prod.InvalidFormattedProductkey |
The ProductKey format is invalid. |
El formato del valor del parámetro ProductKey no es válido. |
Para consultar la lista de códigos de error, visite Códigos de error del servicio.