RegisterDevice - IoT Platform - Centre de documentation Alibaba Cloud

Enregistre un appareil au sein d'un produit.

Notes d'utilisation

Lorsque vous appelez cette opération pour enregistrer un appareil sous un produit, l'appareil est ajouté au produit dans la console IoT Platform. Après l'enregistrement, IoT Platform émet le paramètre IotId pour cet appareil. Ce paramètre constitue l'identifiant global unique (GUID) de l'appareil. Pour effectuer des opérations sur un appareil, vous devez utiliser le paramètre IotId afin de l'identifier.

Vous pouvez également utiliser une combinaison des paramètres ProductKey et DeviceName pour identifier un appareil. Un ProductKey est attribué par IoT Platform à un produit lors de sa création. Un DeviceName est spécifié ou généré de manière aléatoire lors de la création d'un appareil. Le paramètre IotId est prioritaire sur la combinaison des paramètres ProductKey et DeviceName.

Pour plus d'informations sur l'enregistrement simultané de plusieurs appareils sous un produit, consultez BatchRegisterDeviceWithApplyId.

Limites

Chaque compte Alibaba Cloud peut exécuter un maximum de 30 requêtes par seconde (QPS).

Remarque

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

Débogage

Alibaba Cloud met à disposition OpenAPI Explorer pour simplifier l'utilisation des API. OpenAPI Explorer calcule automatiquement la valeur de signature. Par souci de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	RegisterDevice	Opération à effectuer. Définissez la valeur sur RegisterDevice.
ProductKey	String	Yes	a1BwAGV****	ProductKey du produit auquel appartient l'appareil. Un ProductKey est un GUID attribué par IoT Platform à un produit. Utilisez la console IoT Platform ou appelez l'opération QueryProductList pour afficher les informations relatives à tous les produits de votre compte actuel.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	ID de l'instance. Consultez l'ID de l'instance sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez configurer ce paramètre. À défaut, l'appel échouera. Si votre instance ne dispose pas de page Overview ou d'ID, il n'est pas nécessaire de définir ce paramètre. Pour plus d'informations, consultez Overview.
DeviceName	String	No	light	DeviceName de l'appareil. Le nom doit comporter entre 4 et 32 caractères et peut contenir des lettres, des chiffres, des traits d'union (-), des traits de soulignement (_), des signes at (@), des points (.) et des deux-points (:). Utilisez une combinaison des paramètres DeviceName et ProductKey pour identifier un appareil. Remarque Si vous ne spécifiez pas ce paramètre, IoT Platform générera un DeviceName de manière aléatoire.
DevEui	String	No	e8SDdgeIlk3nED****	DevEUI de l'appareil LoRaWAN. Ce paramètre est requis lors de la création d'un appareil LoRaWAN.
Nickname	String	No	Campus light	Alias de l'appareil. L'alias doit comporter entre 4 et 64 caractères et peut contenir des lettres, des chiffres et des traits de soulignement (_). Remarque Si vous ne spécifiez pas ce paramètre, IoT Platform ne générera pas d'alias pour l'appareil.
PinCode	String	No	DIe80dfeg*****	Code PIN de l'appareil LoRaWAN. Ce paramètre sert à vérifier le DevEUI. Lors de la création d'un appareil LoRaWAN, définissez LoraNodeType sur ALIYUNDEFINED. Ce paramètre est obligatoire.
JoinEui	String	No	Ede4tde8erth****	JoinEUI de l'appareil LoRaWAN. Lors de la création d'un appareil LoRaWAN, définissez LoraNodeType sur USERDEFINED. Ce paramètre est obligatoire.
AppKey	String	No	674f***	AppKey de l'appareil LoRaWAN. Lors de la création d'un appareil LoRaWAN, définissez LoraNodeType sur USERDEFINED. Ce paramètre est obligatoire.
LoraNodeType	String	No	ALIYUNDEFINED	Type d'appareil LoRaWAN. Valeurs possibles : ALIYUNDEFINED : l'appareil est émis par Alibaba Cloud. Spécifiez DevEui et PinCode. USERDEFINED : l'appareil est défini par l'utilisateur. Spécifiez DevEui, JoinEui et AppKey.

Outre les paramètres de requête spécifiques à l'opération présentés ci-dessus, vous devez spécifier les paramètres de requête communs lors de l'appel de cette opération. Pour plus d'informations, consultez Common request parameters.

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 Error codes.
Data	Struct		Informations sur l'appareil renvoyées en cas de succès de l'appel.
DevEui	String	e8SDdgeIlk3nED****	DevEUI de l'appareil LoRaWAN. Ce paramètre est renvoyé uniquement lors de la création d'un appareil LoRaWAN.
DeviceName	String	light	DeviceName de l'appareil. Important Gardez ces informations confidentielles.
DeviceSecret	String	mz2Canp4GB7qRVf1OYPNtRqB2anu****	DeviceSecret de l'appareil. Important Gardez ces informations confidentielles.
IotId	String	1O4YPNtRqB2anumz2Canp4GB7q****	ID de l'appareil. Il s'agit de l'identifiant unique attribué par IoT Platform à l'appareil. Important Gardez ces informations confidentielles.
JoinEui	String	Ede4tde8erth****	JoinEUI de l'appareil LoRaWAN. Ce paramètre est renvoyé uniquement lors de la création d'un appareil LoRaWAN.
Nickname	String	Campus light	Alias de l'appareil. Si vous ne spécifiez pas d'alias pour l'appareil, ce paramètre reste vide.
ProductKey	String	a1BwAGV****	ProductKey du produit auquel appartient l'appareil.
ErrorMessage	String	A system exception occurred.	Message d'erreur renvoyé en cas d'échec de l'appel.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	ID de la requête.
Success	Boolean	true	Indique si l'appel a abouti. true : l'appel a réussi. false : l'appel a échoué.

Exemples

Exemples de requêtes

https://iot.cn-shanghai.aliyuncs.com/?Action=RegisterDevice
&ProductKey=a1rYuVF****
&DeviceName=device1
&Nickname=detectors_in_beijing
&<Common request parameters>

Exemples de réponses réussies

Format XML

<RegisterDeviceResponse>
  <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
  <Success>true</Success>
  <Data>
        <DeviceName>device1</DeviceName>
        <ProductKey>a1rYuVF****</ProductKey>
        <DeviceSecret>tXHf4ezGEHcwdyMwoCDHGBmk9avi****</DeviceSecret>
        <IotId>CqXL5h5ysRTA4NxjABjj0010fa****</IotId>
        <Nickname>detectors_in_beijing</Nickname>
  </Data>
</RegisterDeviceResponse>

Format JSON

{
    "RequestId": "57b144cf-09fc-4916-a272-a62902d5b207", 
    "Success": true, 
    "Data": {
        "DeviceName": "device1", 
        "ProductKey": "a1rYuVF****", 
        "DeviceSecret": "tXHf4ezGEHcwdyMwoCDHGBmk9avi****", 
        "IotId": "CqXL5h5ysRTA4NxjABjj0010fa****", 
        "Nickname": "detectors_in_beijing"
    }
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, visitez le Centre d'erreurs API.