ImportDevice - IoT Platform - Centre de documentation Alibaba Cloud

Notes d'utilisation

Avant d'appeler cette opération, assurez-vous d'avoir créé une passerelle MQTT et le produit associé, et d'avoir obtenu la ProductKey du produit.

Limites de QPS

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

Remarque

Les utilisateurs RAM partagent le quota du compte Alibaba Cloud.

Débogage

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

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	ImportDevice	Opération à effectuer. Définissez la valeur sur ImportDevice.
ProductKey	String	Yes	a1BwAGV****	La ProductKey du produit auquel appartient l'appareil.
DeviceName	String	Yes	light	Nom de l'appareil (DeviceName). 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 signes at (@), des points (.) et des deux-points (:). Le DeviceName doit être unique au sein du produit.
DeviceSecret	String	Yes	b4d43f7******10ba5e5	Clé secrète de l'appareil (DeviceSecret). 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 signes at (@), des points (.) et des deux-points (:).
Nickname	String	No	Campus light	Alias de l'appareil. L'alias doit comporter entre 1 et 64 caractères. Il 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ère pas d'alias pour l'appareil.
Sn	String	No	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 Si vous ne spécifiez pas ce paramètre, IoT Platform ne génère pas de SN pour l'appareil.
IotInstanceId	String	No	iot-1n8t****	ID de l'instance. Vous trouverez l'ID sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez le spécifier. Sinon, l'appel échouera. Si aucune page Overview ni aucun ID n'est généré pour votre instance, inutile de spécifier ce paramètre. Pour plus d'informations, consultez la rubrique Overview.

Outre les paramètres de requête spécifiques à l'opération, vous devez spécifier 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

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 rubrique Codes d'erreur.
Data	Struct		Informations sur l'appareil renvoyées en cas de réussite de l'appel.
DeviceName	String	light	Nom de l'appareil (DeviceName). Important Gardez ces informations confidentielles.
DeviceSecret	String	b4d43f7******10ba5e5	Clé secrète de l'appareil (DeviceSecret). Important Gardez ces informations confidentielles.
IotId	String	1O4YPNtRqB2anumz2Canp4GB7*****	ID unique de l'appareil attribué par IoT Platform. Important Gardez ces informations confidentielles.
Nickname	String	Campus light	Alias de l'appareil. Remarque Si vous ne spécifiez pas d'alias pour l'appareil, ce paramètre est vide.
ProductKey	String	a1BwAGV****	La ProductKey du produit auquel appartient l'appareil.
Sn	String	QC4******001	Numéro de série (SN) de l'appareil. Remarque Si vous ne spécifiez pas de SN pour l'appareil, ce paramètre est vide.
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. true : L'appel a réussi. false : L'appel a échoué.

Exemples

Exemple de requête

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ImportDevice
&DeviceName=device1
&DeviceSecret=b4d43f7******10ba5e5
&ProductKey=a1BwAGV****
&IotInstanceId=iot-1n8t****
&<Common request parameters>

Exemple de réponse réussie

XML format

<ImportDeviceResponse>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Data>
        <IotId>1O4YPNtRqB2anumz2Canp4GB7*****</IotId>
        <DeviceSecret>b4d43f7******10ba5e5</DeviceSecret>
        <Sn>QC4******001</Sn>
        <ProductKey>a1BwAGV****</ProductKey>
        <Nickname>Campus light</Nickname>
        <DeviceName>light</DeviceName>
  </Data>
  <Success>true</Success>
</ImportDeviceResponse>

JSON format

{
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Data": {
        "IotId": "1O4YPNtRqB2anumz2Canp4GB7*****",
        "DeviceSecret": "b4d43f7******10ba5e5",
        "Sn": "QC4******001",
        "ProductKey": "a1BwAGV****",
        "Nickname": "Campus light",
        "DeviceName": "light"
    },
    "Success": true
}

Codes d'erreur

HttpCode	Error code	Error message	Description
200	iot.device.CreateDeviceFailed	An error occurred while creating the device.	Le système n'a pas pu créer l'appareil.
200	iot.device.AlreadyExistedDeviceName	The DeviceName already exists.	Le DeviceName spécifié existe déjà dans le produit.

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