ClearDeviceDesiredProperty - IoT Platform: Central de Documentação do Alibaba Cloud

Observações de uso

O parâmetro Identifies é obrigatório. A chamada falha se esse parâmetro não for especificado.
Cada chamada aceita até 10 identificadores de propriedade no parâmetro Identifies.
Após a limpeza dos valores de propriedade desejados, a operação QueryDeviceDesiredProperty retorna o parâmetro Identifier, mas não o parâmetro Value para as propriedades limpas.

Limites de QPS

Cada conta Alibaba Cloud pode chamar esta operação até 50 vezes por segundo.

Nota

Usuários RAM de uma conta Alibaba Cloud compartilham a cota da conta.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Não	ClearDeviceDesiredProperty	A operação a ser executada. Defina o valor como ClearDeviceDesiredProperty.
IotInstanceId	String	Não	iot-2w****	O ID da instância. Visualize o ID da instância na página Overview no console do IoT Platform. Importante Se sua instância tiver um ID, especifique este parâmetro. Caso contrário, a chamada falhará. Se nenhuma página Overview ou ID for gerada para sua instância, não é necessário especificar este parâmetro. Para mais informações, consulte Visão geral.
ProductKey	String	Não	a1BwAGV****	A ProductKey do produto ao qual o dispositivo pertence. Nota Ao especificar um valor para este parâmetro, configure também o parâmetro DeviceName.
DeviceName	String	Não	light	O DeviceName do dispositivo. Nota Ao especificar um valor para este parâmetro, configure também o parâmetro ProductKey.
Identifies.N	RepeatList	Não	temperature	Os identificadores das propriedades cujos valores desejados serão excluídos. É possível especificar até 10 identificadores de propriedade.
IotId	String	Não	Q7uOhVRdZRRlDnTLv****00100	O ID do dispositivo, um identificador exclusivo emitido pelo IoT Platform. Nota O parâmetro IotId especifica um identificador globalmente exclusivo (GUID) para o dispositivo. O valor do parâmetro IotId equivale à combinação dos valores dos parâmetros ProductKey e DeviceName. Se você especificar um valor para o parâmetro IotId, não será necessário configurar o parâmetro ProductKey ou DeviceName. Caso especifique valores para os parâmetros IotId, ProductKey e DeviceName, o valor do parâmetro IotId terá precedência.

Além dos parâmetros de solicitação específicos da operação acima, especifique também os parâmetros de solicitação comuns. Para mais informações, consulte Parâmetros comuns.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
Code	String	iot.system.SystemException	O código de erro retornado se a chamada falhar. Para mais informações, consulte a seção "Códigos de erro" deste tópico.
Data	Struct		Os dados retornados se a chamada for bem-sucedida.
Versions	String	{\"temperature\":0}	Os números de versão mais recentes dos valores de propriedade desejados após a limpeza dos valores especificados.
ErrorMessage	String	A system exception occurred.	A mensagem de erro retornada se a chamada falhar.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	O ID da solicitação.
Success	Boolean	true	Indica se a chamada foi bem-sucedida. Valores válidos: true: A chamada foi bem-sucedida. false: A chamada falhou.

Exemplos

Exemplos de solicitações

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

Exemplos de respostas de sucesso

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 erro

HttpCode	Código de erro	Mensagem de erro	Descrição
400	iot.device.InvalidFormattedDeviceName	The DeviceName format is invalid.	Mensagem de erro retornada porque o formato do DeviceName é inválido.
400	iot.device.NotSupportExemptionValidateType	The feature does not support the specified verification type.	Mensagem de erro retornada porque o recurso não oferece suporte ao modelo TSL do tipo sem verificação.
400	iot.prod.NotExistedProduct	The specified product does not exist.	Mensagem de erro retornada porque o produto especificado não existe.
400	iot.prod.QueryProductPropertyFailed	An error occurred while querying the product property.	Mensagem de erro retornada porque o sistema falhou ao consultar a propriedade do produto.
400	iot.check.InvalidFormattedParameter	The parameter format is invalid.	Mensagem de erro retornada porque o formato do valor do parâmetro é inválido.
400	Iot.digitaltwin.DTInstanceInvalidThingType	The digital twin operation is not supported.	Mensagem de erro retornada porque esta operação não oferece suporte a dados do tipo gêmeo.
400	iot.check.NullParameter	Specify parameter is null.	Mensagem de erro retornada porque nenhum valor foi especificado para o parâmetro.
400	iot.device.CanNotSetReadOnlyProperty	Cannot set read only property.	Mensagem de erro retornada porque não é possível consultar os valores desejados de propriedades somente leitura.
400	iot.device.DeviceIsDisable	The specified device has been disabled.	Mensagem de erro retornada porque o dispositivo está desativado.
400	iot.device.InvalidIoTId	The specified device ID is invalid.	Mensagem de erro retornada porque o ID do dispositivo é inválido.
400	iot.device.NullDeviceName	The DeviceName parameter cannot be empty.	Mensagem de erro retornada porque nenhum DeviceName foi especificado para o dispositivo.
400	iot.prod.NullProductKey	The ProductKey parameter cannot be empty.	Mensagem de erro retornada porque nenhum valor foi especificado para o parâmetro ProductKey.
400	iot.prod.InvalidFormattedProductkey	The ProductKey format is invalid.	Mensagem de erro retornada porque o formato do valor do parâmetro ProductKey é inválido.
400	iot.common.InvalidTenant	The Invalid tenant.	Mensagem de erro retornada porque o locatário é inválido ou falhou ao ser criado.
400	iot.prod.QueryPropertyNotFound	Query property not found.	Mensagem de erro retornada porque as propriedades consultadas não existem.
400	iot.device.ClearPropertyDesiredFailed	Failed to clear desired value of property.	Mensagem de erro retornada porque o sistema falhou ao excluir os valores de propriedade desejados.
400	iot.prod.QueryProductAbilitiesNotFound	query product abilities not found.	Mensagem de erro retornada porque o recurso do produto consultado não existe.
400	iot.Device.NotExistedDevice	This device does not exist.	Mensagem de erro retornada porque o dispositivo não existe ou não está ativado.
400	iot.prod.NullAbilityIdentifier	You must specify a feature identifier.	Mensagem de erro retornada porque nenhum identificador foi especificado para o recurso.
400	iot.system.IllegalRequest	The request parameter is invalid.	Mensagem de erro retornada porque o valor do parâmetro de solicitação é inválido.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.