Supprime un appareil. Si vous appelez cette opération pour supprimer une passerelle, les relations topologiques entre la passerelle et les sous-appareils qui y sont connectés sont également supprimées.
Notes d'utilisation
Avant d'appeler cette opération
Si vous souhaitez appeler cette opération en tant qu'utilisateur Resource Access Management (RAM), créez des politiques d'autorisation personnalisées afin d'accorder des autorisations granulaires à l'utilisateur RAM. Cette démarche garantit la sécurité des appareils. Pour plus d'informations, consultez les rubriques Mappage entre les opérations API IoT Platform et les politiques RAM et Autorisations personnalisées.
Une fois l'appareil supprimé, son ID (IotId) devient invalide et toutes les autres informations associées à l'appareil sont effacées. Vous ne pouvez plus effectuer aucune opération sur cet appareil.
Avant de supprimer un appareil dans la console IoT Platform, assurez-vous que l'appareil physique est hors ligne. Dans le cas contraire, l'appareil physique continue d'envoyer des demandes de connexion à IoT Platform après sa suppression de la plateforme. Lorsque le nombre de demandes dépasse la limite supérieure, IoT Platform applique une limitation du débit. Par conséquent, d'autres appareils de votre compte Alibaba Cloud risquent de ne pas pouvoir se connecter à IoT Platform.
Après la suppression d'un appareil, son certificat devient invalide et ne peut pas être restauré. Procédez avec prudence.
Lors de l'appel de cette opération
Spécifiez l'identifiant IotId ou bien les paramètres ProductKey et DeviceName pour désigner un appareil.
Si vous appelez cette opération pour supprimer une passerelle à laquelle plus de 2 000 sous-appareils sont connectés, l'opération crée une tâche asynchrone afin de supprimer les relations topologiques. L'opération renvoie alors l'identifiant JobId de la tâche asynchrone.
Limites QPS
Vous pouvez appeler cette opération jusqu'à 50 fois par seconde par compte.
Les utilisateurs RAM d'un compte Alibaba Cloud partagent le quota de ce compte.
Débogage
Paramètres de requête
Paramètre | Type | Obligatoire | Exemple | Description |
Action | String | Oui | DeleteDevice | Opération à effectuer. Définissez la valeur sur DeleteDevice. |
IotInstanceId | String | Non | iot-cn-0pp1n8t**** | ID de l'instance. Vous pouvez consulter l'ID de l'instance dans l'onglet Overview de la console IoT Platform. Important
Pour plus d'informations sur les instances, consultez la rubrique Vue d'ensemble. |
ProductKey | String | Non | a1FlqIQ**** | ProductKey du produit auquel appartient l'appareil. Important Si vous spécifiez ce paramètre, vous devez également spécifier le paramètre DeviceName. |
DeviceName | String | Non | light | Nom de l'appareil à supprimer. Important Si vous spécifiez ce paramètre, vous devez également spécifier le paramètre ProductKey. |
IotId | String | Non | MpEKNuEUJzIORNANAWJX0010929900* | ID de l'appareil à supprimer. Important Le paramètre IotId correspond au GUID d'un appareil. Il représente la combinaison du ProductKey et du DeviceName. Si vous spécifiez ce paramètre, il n'est pas nécessaire de renseigner les paramètres ProductKey ou DeviceName. Si vous spécifiez simultanément les paramètres IotId, ProductKey et DeviceName, le paramètre IotId est prioritaire. |
Outre les paramètres de requête spécifiques à cette opération, vous devez spécifier les paramètres de requête communs lors de l'appel. Pour plus d'informations sur les paramètres communs, consultez la rubrique Paramètres communs.
Paramètres de réponse
Paramètre | Type | Exemple | Description |
Code | String | iot.prod.NullProductKey | Code d'erreur renvoyé en cas d'échec de la requête. Pour plus d'informations sur les codes d'erreur, consultez la rubrique Codes d'erreur. |
ErrorMessage | String | The product ID is invalid. | Message d'erreur renvoyé en cas d'échec de la requête. |
RequestId | String | 57b144cf-09fc-4916-a272-a62902d5b207 | ID de la requête. |
Success | Boolean | false | Indique si la requête a abouti. Valeurs possibles :
|
Exemples
Exemple de requête
https://iot.cn-shanghai.aliyuncs.com/?Action=DeleteDevice
&ProductKey=a1rYuVF****
&DeviceName=device1
&<Common request parameters>
Exemple de réponse en cas de succès
XML format
<DeleteDeviceResponse>
<RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
<Success>true</Success>
</DeleteDeviceResponse>
JSON format
{
"RequestId":"57b144cf-09fc-4916-a272-a62902d5b207",
"Success": true
}
Codes d'erreur
Pour obtenir la liste des codes d'erreur, consultez la rubrique Codes d'erreur de service.