Ajoute plusieurs appareils à un produit de passerelle cloud en une seule opération.
Remarques d'utilisation
L'opération BatchImportVehicleDevice permet d'ajouter simultanément plusieurs appareils à un produit de passerelle cloud JT/T 808 ou GB/T 32960.
Limites QPS
Vous pouvez appeler cette API jusqu'à 10 fois par seconde par compte.
Les utilisateurs RAM d'un compte Alibaba Cloud partagent le quota du compte.
Débogage
Paramètres de requête
|
Parameter |
Type |
Required |
Example |
Description |
| Action | String | Yes | BatchImportVehicleDevice | Opération à effectuer. Définissez la valeur sur BatchImportVehicleDevice. |
| IotInstanceId | String | Yes | iot-1n8t**** | ID de l'instance. Vous pouvez consulter l'ID de l'instance dans l'onglet Overview de la console IoT Platform. Pour plus d'informations, consultez Overview. |
| ProductKey | String | Yes | a1Bw**** | ProductKey du produit auquel l'appareil appartient. |
| DeviceList.N.Manufacturer | String | No | mf0001 | ID du fabricant de l'appareil. Ce paramètre est obligatoire pour ajouter un appareil de passerelle cloud JT/T 808. L'ID du fabricant doit comporter entre 4 et 11 caractères et peut contenir des lettres, des chiffres et des traits d'union (-). Remarque Spécifiez jusqu'à 10 000 ID de fabricant d'appareil par appel. Les ID excédentaires sont ignorés. |
| DeviceList.N.DeviceModel | String | No | dm0001 | Modèle de l'appareil. Ce paramètre est obligatoire pour ajouter un appareil de passerelle cloud JT/T 808. Le modèle de l'appareil doit comporter entre 4 et 30 caractères et peut contenir des lettres, des chiffres et des traits d'union (-). Remarque Spécifiez jusqu'à 10 000 modèles d'appareil par appel. Les modèles excédentaires sont ignorés. |
| DeviceList.N.DeviceId | String | No | di0001 | ID de l'appareil. Ce paramètre est obligatoire pour ajouter un appareil de passerelle cloud JT/T 808. L'ID doit comporter entre 4 et 30 caractères et peut contenir des lettres, des chiffres et des traits d'union (-). Remarque Spécifiez jusqu'à 10 000 ID d'appareil par appel. Les ID excédentaires sont ignorés. |
| DeviceList.N.DeviceName | String | No | vin0001 | DeviceName de l'appareil. Pour ajouter un appareil de passerelle cloud JT/T 808, spécifiez le numéro d'identification du véhicule (VIN) de l'appareil comme valeur de ce paramètre. Le DeviceName doit comporter entre 4 et 17 caractères et peut contenir des lettres et des chiffres. Remarque Spécifiez jusqu'à 10 000 DeviceNames par appel. Les DeviceNames excédentaires sont ignorés. |
Outre les paramètres de requête spécifiques à l'opération, vous devez configurer les paramètres de requête communs lors de l'appel. Pour plus d'informations, consultez Paramètres communs.
Paramètres de réponse
Parameter |
Type |
Example |
Description |
| Code | String | iot.system.SystemException | Code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations, consultez la section « Codes d'erreur » de cette rubrique. |
| Data | Struct | Données renvoyées en cas de réussite de l'appel. |
|
| ApplyId | Long | 1295006 | ID de demande (ApplyId) renvoyé pour la requête en cas de réussite de l'appel. |
| InvalidDetailList | Array of InvalidDetailList | Détails des appareils non valides renvoyés en cas d'échec de l'appel. |
|
| InvalidDetailList | |||
| DeviceId | String | di_*0001 | ID des appareils de passerelle cloud JT/T 808. |
| DeviceModel | String | dm_*0001 | Modèles des appareils de passerelle cloud JT/T 808. |
| DeviceName | String | device_*0001 | DeviceNames des appareils de passerelle cloud GB/T 32960. |
| ErrorMsg | String | The device name is illegal. | Message d'erreur renvoyé en cas d'échec de l'appel. |
| Manufacturer | String | mf_*0001 | ID des fabricants des appareils de passerelle cloud JT/T 808. |
| InvalidDeviceIdList | List | { "InvalidDeviceIdList": [ "di&^", "&*G%" ] } | ID d'appareil non valides renvoyés en cas d'échec de l'ajout d'appareils de passerelle cloud JT/T 808. |
| InvalidDeviceModelList | List | { "InvalidDeviceModelList": [ "dm$", "dm_uh" ] } | Modèles d'appareil non valides renvoyés en cas d'échec de l'ajout d'appareils de passerelle cloud JT/T 808. |
| InvalidDeviceNameList | List | { "InvalidDeviceNameList": [ "APT$", "aw" ] } | DeviceNames non valides renvoyés en cas d'échec de l'ajout d'appareils de passerelle cloud GB/T 32960. |
| InvalidManufacturerList | List | { "InvalidManufacturerList": [ "bm*$", "#$F" ] } | ID de fabricant d'appareil non valides renvoyés en cas d'échec de l'ajout d'appareils de passerelle cloud JT/T 808. |
| RepeatedDeviceIdList | List | { "RepeatedDeviceIdList": [ "^67$", "1" ] } | ID d'appareil en double renvoyés en cas d'échec de l'ajout d'appareils de passerelle cloud JT/T 808. |
| RepeatedDeviceNameList | List | { "RepeatedDeviceNameList": [ "abcd", "asdf" ] } | DeviceNames en double renvoyés en cas d'échec de l'ajout d'appareils de passerelle cloud GB/T 32960. |
| ErrorMessage | String | A system exception occurred. | Message d'erreur renvoyé en cas d'échec de l'appel. |
| RequestId | String | E4C0FF92-2A86-41DB-92D3-73B60310D25E | ID de la requête. |
| Success | Boolean | true | Indique si l'appel a réussi. Valeurs possibles :
|
Exemples
Exemple de requête
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>Exemple de réponse réussie
Format XML
<BatchImportVehicleDeviceResponse>
<RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
<Data>
<ApplyId>1295006</ApplyId>
</Data>
<Code></Code>
<Success>true</Success>
</BatchImportVehicleDeviceResponse>Format JSON
{
"RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
"Data": {
"ApplyId": 1295006
},
"Code": "",
"Success": true
}Codes d'erreur
|
HttpCode |
Error Code |
Error message |
Description |
|
400 |
iot.device.TooManyDeviceNamesPerRequest |
The devices you query exceed the maximum number. |
Le nombre de DeviceNames spécifiés dans la requête dépasse la limite. |
|
400 |
iot.device.ApplyManyDevicesFailed |
An error occurred while creating multiple devices. |
Échec de la création simultanée de plusieurs appareils. |
|
400 |
iot.common.InvalidTenant |
the device tenantId is invalid. |
Les informations de locataire de l'appareil ne sont pas valides. |
|
400 |
iot.device.InvalidFormattedDeviceNameInNameArray |
The DeviceName list contains an invalid DeviceName. |
La liste des DeviceNames contient un DeviceName non valide. |
|
400 |
iot.prod.InvalidProductAuthType |
The product authentication type is invalid. |
Le type de certification du produit n'est pas valide. |
|
400 |
iot.prod.InvalidFormattedProductkey |
The ProductKey format is invalid. |
Le format de la valeur du paramètre ProductKey n'est pas valide. |
Pour obtenir la liste des codes d'erreur, consultez les Codes d'erreur de service.