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

Borra los valores de propiedad deseados de un dispositivo.

Notas de uso

El parámetro Identifies es obligatorio. Si no especifica este parámetro, la llamada falla.
Cada llamada admite hasta 10 identificadores de propiedad en el parámetro Identifies.
Después de borrar los valores de propiedad deseados, al llamar a la operación QueryDeviceDesiredProperty, se devuelve el parámetro Identifier pero no el parámetro Value para las propiedades borradas.

Límites de QPS

Cada cuenta de Alibaba Cloud puede llamar a esta operación hasta 50 veces por segundo.

Nota

Los usuarios 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 llamar 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	No	ClearDeviceDesiredProperty	La operación que desea ejecutar. Establezca el valor en ClearDeviceDesiredProperty.
IotInstanceId	String	No	iot-2w****	ID de la instancia. Consulte el ID de la instancia en la página Overview de la consola de IoT Platform. Importante Si su instancia tiene un ID, debe especificar este parámetro. De lo contrario, la llamada falla. Si no se genera ninguna página de Overview o ID para su instancia, no necesita especificar este parámetro. Para obtener más información, consulte Descripción general.
ProductKey	String	No	a1BwAGV****	La clave ProductKey del producto al que pertenece el dispositivo. Nota Si especifica un valor para este parámetro, debe configurar el parámetro DeviceName.
DeviceName	String	No	light	El nombre del dispositivo (DeviceName). Nota Si especifica un valor para este parámetro, debe configurar el parámetro ProductKey.
Identifies.N	RepeatList	No	temperature	Identificadores de las propiedades cuyos valores deseados desea eliminar. Puede especificar hasta 10 identificadores de propiedad.
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	ID del dispositivo; identificador único que emite IoT Platform para el dispositivo. Nota El parámetro IotId especifica un identificador único global (GUID) para el dispositivo. El valor del parámetro IotId equivale a una combinación de los valores de los parámetros ProductKey y DeviceName. Si especifica un valor para el parámetro IotId, no necesita configurar el parámetro ProductKey ni DeviceName. Si especifica valores para los parámetros IotId, ProductKey y DeviceName, el valor del parámetro IotId tiene prioridad.

Además de los parámetros de solicitud específicos de la operación anteriores, también debe especificar los parámetros de solicitud comunes. Para obtener más información, consulte Parámetros comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	Código de error devuelto si la llamada falla. Para obtener más información, consulte la sección "Error codes" de este tema.
Data	Struct		Datos devueltos si la llamada es exitosa.
Versions	String	{\"temperature\":0}	Números de versión más recientes de los valores de propiedad deseados después de borrar los valores especificados.
ErrorMessage	String	A system exception occurred.	Mensaje de error devuelto si la llamada falla.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. Valores válidos: true: La llamada fue exitosa. false: La llamada falló.

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=ClearDeviceDesiredProperty
&ProductKey=a1BwAGV****
&DeviceName=device1
&Identifies.1=temperature
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<ClearDeviceDesiredPropertyResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <Versions>{"temperature":0}</Versions>
  </Data>
  <Code></Code>
  <Success>true</Success>
</ClearDeviceDesiredPropertyResponse>

Formato JSON

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "Versions": "{\"temperature\":0}"
    },
    "Code": "",
    "Success": true
}

Códigos de error

HttpCode	Código de error	Mensaje de error	Descripción
400	iot.device.InvalidFormattedDeviceName	The DeviceName format is invalid.	Mensaje de error devuelto porque el formato del DeviceName no es válido.
400	iot.device.NotSupportExemptionValidateType	The feature does not support the specified verification type.	Mensaje de error devuelto porque la función no admite el modelo TSL del tipo sin verificación.
400	iot.prod.NotExistedProduct	The specified product does not exist.	Mensaje de error devuelto porque el producto especificado no existe.
400	iot.prod.QueryProductPropertyFailed	An error occurred while querying the product property.	Mensaje de error devuelto porque el sistema no pudo consultar la propiedad del producto.
400	iot.check.InvalidFormattedParameter	The parameter format is invalid.	Mensaje de error devuelto porque el formato del valor del parámetro no es válido.
400	Iot.digitaltwin.DTInstanceInvalidThingType	The digital twin operation is not supported.	Mensaje de error devuelto porque esta operación no admite datos del tipo gemelo.
400	iot.check.NullParameter	Specify parameter is null.	Mensaje de error devuelto porque no se especificó ningún valor para el parámetro.
400	iot.device.CanNotSetReadOnlyProperty	Cannot set read only property.	Mensaje de error devuelto porque no se pueden consultar los valores deseados de las propiedades de solo lectura.
400	iot.device.DeviceIsDisable	The specified device has been disabled.	Mensaje de error devuelto porque el dispositivo está deshabilitado.
400	iot.device.InvalidIoTId	The specified device ID is invalid.	Mensaje de error devuelto porque el ID del dispositivo no es válido.
400	iot.device.NullDeviceName	The DeviceName parameter cannot be empty.	Mensaje de error devuelto porque no se especificó ningún DeviceName para el dispositivo.
400	iot.prod.NullProductKey	The ProductKey parameter cannot be empty.	Mensaje de error devuelto porque no se especificó ningún valor para el parámetro ProductKey.
400	iot.prod.InvalidFormattedProductkey	The ProductKey format is invalid.	Mensaje de error devuelto porque el formato del valor del parámetro ProductKey no es válido.
400	iot.common.InvalidTenant	The Invalid tenant.	Mensaje de error devuelto porque el inquilino no es válido o no se pudo crear.
400	iot.prod.QueryPropertyNotFound	Query property not found.	Mensaje de error devuelto porque las propiedades consultadas no existen.
400	iot.device.ClearPropertyDesiredFailed	Failed to clear desired value of property.	Mensaje de error devuelto porque el sistema no pudo eliminar los valores de propiedad deseados.
400	iot.prod.QueryProductAbilitiesNotFound	query product abilities not found.	Mensaje de error devuelto porque la función del producto consultada no existe.
400	iot.Device.NotExistedDevice	This device does not exist.	Mensaje de error devuelto porque el dispositivo no existe o no está activado.
400	iot.prod.NullAbilityIdentifier	You must specify a feature identifier.	Mensaje de error devuelto porque no se especificó ningún identificador para la función.
400	iot.system.IllegalRequest	The request parameter is invalid.	Mensaje de error devuelto porque el valor del parámetro de solicitud no es válido.

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