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

Limites de QPS

Cada conta pode chamar esta operação de API até 500 vezes por segundo.

Nota

Os usuários RAM de uma conta Alibaba Cloud compartilham a cota dessa conta.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos que você chame esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parameter	Type	Required	Example	Description
Action	String	Yes	UpdateDeviceShadow	Operação a ser executada. Defina o valor como UpdateDeviceShadow.
DeviceName	String	Yes	device1	Nome do dispositivo cujo shadow será modificado.
ProductKey	String	Yes	a1T27vz****	ProductKey do produto ao qual o dispositivo pertence.
ShadowMessage	String	Yes	{"method":"update","state":{"desired":{"color":"green"}},"version":2}	Informações do shadow do dispositivo a serem atualizadas. Este parâmetro inclui os seguintes campos: method: tipo da operação. Tipo de dados: string. Defina o valor como update. state: status do shadow do dispositivo. Tipo de dados: string. O parâmetro desired especifica o status esperado do shadow. version: versão do shadow do dispositivo. Tipo de dados: long. Se o controle de versão não for necessário, defina este parâmetro como 0. Se o controle de versão for obrigatório, especifique uma versão posterior à atual. Importante Quando o controle de versão for necessário, não consulte a versão do shadow do dispositivo no console do IoT Platform. Se muitas operações de atualização e consulta ocorrerem simultaneamente, várias atualizações poderão retornar a mesma versão, e a mais recente pode ser concluída primeiro. Isso pode deixar as informações atuais do shadow desatualizadas. Recomendamos manter as versões do shadow do dispositivo localmente e usar um aplicativo on-premises para obter a versão mais recente ao chamar esta operação.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	ID da instância de contêiner elástico. Visualize o ID da instância na página Overview no console do IoT Platform. Importante Se sua instância possuir um ID, será obrigatório especificá-lo neste parâmetro. Caso contrário, a chamada falhará. Se não houver uma página Overview ou ID gerado para sua instância, não é necessário definir este parâmetro. Para mais informações, consulte Visão geral.
DeltaUpdate	Boolean	No	false	Define se deve ser realizada uma atualização incremental no parâmetro desired. Valores válidos: true: executa uma atualização incremental. false (padrão): executa uma atualização completa.

Além dos parâmetros de solicitação anteriores, especifique os parâmetros de solicitação comuns ao chamar esta operação. Para mais informações, consulte Parâmetros comuns.

Parâmetros de resposta

Parameter	Type	Example	Description
Code	String	iot.system.SystemException	Código de erro retornado se a chamada falhar. Para mais informações, consulte Códigos de erro.
ErrorMessage	String	A system exception occurred.	Mensagem de erro retornada se a chamada falhar.
RequestId	String	6754C0E7-A35D-4CC8-A684-45EB1F0008D9	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=UpdateDeviceShadow
&ProductKey=a1T27vz****
&DeviceName=device1
&ShadowMessage={"method":"update","state":{"desired":{"color":"green"}},"version":1}
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

<UpdateDeviceShadowResponse>
        <RequestId>BB71E443-4447-4024-A000-EDE09922891E</RequestId>
        <Success>true</Success>
  </UpdateDeviceShadowResponse>

Formato JSON

{
	"RequestId": "6754C0E7-A35D-4CC8-A684-45EB1F0008D9",
	"Success": true
}

Códigos de erro

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