BatchImportDevice - IoT Platform - Centre de documentation Alibaba Cloud

Notes d'utilisation

Avant d'ajouter des appareils à un produit de passerelle MQTT, créez la passerelle MQTT et le produit associé, puis récupérez la ProductKey. Pour plus d'informations, consultez la rubrique Créer une passerelle MQTT.

Limites de QPS

Vous pouvez appeler cette opération API jusqu'à 10 fois par seconde par compte.

Remarque

Les utilisateurs RAM d'un compte Alibaba Cloud partagent le quota du compte.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. L'outil génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	BatchImportDevice	Opération à effectuer. Définissez la valeur sur BatchImportDevice.
ProductKey	String	Oui	a1BwAGV****	ProductKey du produit auquel l'appareil appartient. La ProductKey est l'identifiant unique d'un produit dans IoT Platform. Consultez les produits dans la console IoT Platform ou appelez l'opération QueryProductList.
DeviceList.N.DeviceName	String	Oui	device1	DeviceName de l'appareil. Le DeviceName doit comporter entre 4 et 32 caractères. Il peut contenir des lettres, des chiffres, des traits d'union (-), des traits de soulignement (_), des arobases (@), des points (.) et des deux-points (:). Le DeviceName doit être unique au sein du produit. Remarque Spécifiez jusqu'à 10 000 DeviceNames par appel. Si ce nombre dépasse la limite, les DeviceNames excédentaires sont ignorés.
DeviceList.N.DeviceSecret	String	Oui	b4d43f7******10ba5e5	DeviceSecret de l'appareil. Le DeviceSecret doit comporter entre 1 et 32 caractères. Il peut contenir des lettres, des chiffres, des traits d'union (-), des traits de soulignement (_), des arobases (@), des points (.) et des deux-points (:). Remarque Spécifiez jusqu'à 10 000 DeviceSecrets par appel. Si ce nombre dépasse la limite, les DeviceSecrets excédentaires sont ignorés.
DeviceList.N.Sn	String	Non	QC4******001	Numéro de série (SN) de l'appareil. Le SN doit comporter entre 1 et 64 caractères. Il peut contenir des lettres, des chiffres et des traits de soulignement (_). Remarque Spécifiez jusqu'à 10 000 SN par appel. Si ce nombre dépasse la limite, les SN excédentaires sont ignorés.
IotInstanceId	String	Non	iot-1n8t****	ID de l'instance. Vous trouverez cet ID sur la page Aperçu de la console IoT Platform. Important Si votre instance possède un ID, vous devez spécifier cet ID pour ce paramètre. Sinon, l'appel échoue. Si aucune page Aperçu ni aucun ID n'est généré pour votre instance, ne configurez pas ce paramètre. Pour plus d'informations, consultez la rubrique Aperçu.

Outre les paramètres spécifiques à l'opération listés ci-dessus, spécifiez les paramètres de requête communs lors de l'appel à cette opération. Pour plus d'informations, consultez la rubrique Paramètres communs.

Paramètres de réponse

Paramètre	Type	Exemple	Description
Code	String	iot.system.SystemException	Code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations, consultez la rubrique Codes d'erreur.
Data	Struct		Données renvoyées si l'appel réussit.
ApplyId	Long	1295006	ID de demande (ApplyId) généré pour une requête réussie.
InvalidDetailList	Array of InvalidDetailList		Détails des appareils non valides renvoyés en cas d'échec de l'appel.
InvalidDetailList
DeviceName	String	light%	DeviceName de l'appareil.
DeviceSecret	String	^67$	DeviceSecret de l'appareil.
ErrorMsg	String	The device name is illegal.	Message d'erreur renvoyé en cas d'échec de l'appel.
Sn	String	QC4001#	SN de l'appareil.
InvalidDeviceNameList	List	{ "InvalidDeviceNameList": [ "APT$", "aw" ] }	DeviceNames des appareils non valides renvoyés en cas d'échec de l'appel.
InvalidDeviceSecretList	List	{ "InvalidDeviceSecretList": [ "^67$", "1" ] }	DeviceSecrets des appareils non valides renvoyés en cas d'échec de l'appel.
InvalidSnList	List	{ "InvalidSnList": [ "" ] }	SN des appareils non valides renvoyés en cas d'échec de l'appel.
RepeatedDeviceNameList	List	{ "RepeatedDeviceNameList": [ "abcd", "asdf" ] }	DeviceNames en double renvoyés en cas d'échec de l'appel.
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 : true : L'appel a réussi. false : L'appel a échoué.

Description

Exemples de requêtes

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>

Exemples de réponses réussies

XML format

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

JSON format

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

Codes d'erreur

HttpCode	Code d'erreur	Message d'erreur	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.	Le système n'a pas pu créer plusieurs appareils simultanément.
400	iot.device.DeviceNumerExceedTenant	The device total number beyond limit.	Le nombre d'appareils dépasse la limite.

Pour obtenir la liste des codes d'erreur, consultez la rubrique Codes d'erreur de service.