DeleteDevice - IoT Platform - Centro de documentación de Alibaba Cloud

Elimina un dispositivo. Si llama a esta operación para eliminar una puerta de enlace, también se eliminan las relaciones topológicas entre la puerta de enlace y los subdispositivos conectados a ella.

Notas de uso

Antes de llamar a esta operación

Si desea llamar a esta operación como usuario de Resource Access Management (RAM), puede crear políticas de permisos personalizadas para otorgar permisos detallados al usuario de RAM. Esto garantiza la seguridad del dispositivo. Para obtener más información, consulte Correspondencia entre las operaciones de la API de IoT Platform y las políticas de RAM y Permisos personalizados.

Aviso

Una vez eliminado un dispositivo, el ID del dispositivo (IotId) deja de ser válido y se elimina toda la demás información asociada al dispositivo. Además, ya no podrá realizar ninguna operación sobre el dispositivo.
Antes de eliminar un dispositivo en la consola de IoT Platform, asegúrese de que el dispositivo físico esté desconectado. De lo contrario, el dispositivo físico iniciará continuamente solicitudes de conexión a IoT Platform después de que el dispositivo se elimine de IoT Platform. Cuando el número de solicitudes supera el límite superior, IoT Platform limita las solicitudes. En este caso, es posible que otros dispositivos dentro de su cuenta de Alibaba Cloud no puedan conectarse a IoT Platform.
Después de eliminar un dispositivo, el certificado del dispositivo deja de ser válido y no se puede restaurar. Proceda con precaución.

Al llamar a esta operación

Debe especificar el IotId o bien la ProductKey y el DeviceName para identificar un dispositivo.
Si llama a esta operación para eliminar una puerta de enlace a la que están conectados más de 2,000 subdispositivos, esta operación crea un trabajo de dispositivo asíncrono para eliminar las relaciones topológicas. Esta operación devuelve el JobId del trabajo asíncrono.

Límites de QPS

Puede llamar a esta operación hasta 50 veces por segundo por cuenta.

Nota

Los usuarios de RAM de una cuenta de Alibaba Cloud comparten la cuota de la cuenta.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos que llame a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	DeleteDevice	La operación que desea realizar. Establezca el valor en DeleteDevice.
IotInstanceId	String	No	iot-cn-0pp1n8t****	El ID de la instancia. Puede consultar el ID de la instancia en la pestaña Overview de la consola de IoT Platform. Importante Debe especificar este parámetro si su instancia tiene un ID. De lo contrario, la solicitud fallará. Si la pestaña Overview o el ID de la instancia no se muestran en la consola de IoT Platform, no necesita especificar este parámetro. Para obtener más información sobre las instancias, consulte Descripción general.
ProductKey	String	No	a1FlqIQ****	La ProductKey del producto al que pertenece el dispositivo. Importante Si especifica este parámetro, también debe especificar el DeviceName.
DeviceName	String	No	light	El nombre del dispositivo que desea eliminar. Importante Si especifica este parámetro, también debe especificar la ProductKey.
IotId	String	No	MpEKNuEUJzIORNANAWJX0010929900*	El ID del dispositivo que desea eliminar. Importante Un IotId especifica el GUID de un dispositivo. El IotId corresponde a la combinación de la ProductKey y el DeviceName. Si especifica este parámetro, no necesita especificar la ProductKey ni el DeviceName. Si especifica el IotId, la ProductKey y el DeviceName al mismo tiempo, el IotId tiene prioridad.

Además de los parámetros de solicitud específicos de la operación anteriores, debe especificar parámetros de solicitud comunes al llamar a esta operación. Para obtener más información sobre los parámetros de solicitud comunes, consulte Parámetros comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.prod.NullProductKey	El código de error que se devuelve si la solicitud falló. Para obtener más información sobre los códigos de error, consulte Códigos de error.
ErrorMessage	String	The product ID is invalid.	El mensaje de error que se devuelve si la solicitud falló.
RequestId	String	57b144cf-09fc-4916-a272-a62902d5b207	El ID de la solicitud.
Success	Boolean	false	Indica si la solicitud fue exitosa. Valores válidos: true false

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

Formato XML

<DeleteDeviceResponse>
  <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
  <Success>true</Success>
</DeleteDeviceResponse>

Formato JSON

{
  "RequestId":"57b144cf-09fc-4916-a272-a62902d5b207",
  "Success": true
}

Códigos de error

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.