UpdateDeviceShadow - IoT Platform - Alibaba Cloud Documentation Center

Memodifikasi device shadow.

Batas QPS

Anda dapat memanggil Operasi API ini hingga 500 kali per detik per akun.

Catatan Pengguna RAM dari Akun Alibaba Cloud berbagi kuota akun tersebut.

Debugging

OpenAPI Explorer secara otomatis menghitung nilai signature. Untuk kenyamanan Anda, kami menyarankan agar Anda memanggil operasi ini di OpenAPI Explorer. OpenAPI Explorer secara dinamis menghasilkan contoh kode operasi untuk berbagai SDK.

Parameter permintaan

Parameter	Type	Required	Example	Description
Action	String	Yes	UpdateDeviceShadow	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke UpdateDeviceShadow.
DeviceName	String	Yes	device1	Nama perangkat yang informasi shadownya ingin Anda modifikasi.
ProductKey	String	Yes	a1T27vz****	ProductKey produk tempat perangkat tersebut terdaftar.
ShadowMessage	String	Yes	{"method":"update","state":{"desired":{"color":"green"}},"version":2}	Informasi yang ingin Anda tetapkan untuk device shadow. Informasi tersebut mencakup parameter berikut: method: jenis operasi. Tipe data: string. Tetapkan nilainya ke update. state: status device shadow. Tipe data: string. Parameter desired menentukan status shadow yang diharapkan. version: versi device shadow. Tipe data: long. Jika Pengendalian versi tidak diperlukan, tetapkan parameter ini ke 0. Jika Pengendalian versi diperlukan, tentukan versi yang lebih baru daripada versi saat ini. Penting Jika Pengendalian versi diperlukan, jangan melakukan kueri versi device shadow di Konsol Platform IoT. Jika sejumlah besar operasi pembaruan dan kueri dilakukan secara bersamaan, beberapa operasi pembaruan mungkin mengembalikan versi yang sama. Dalam kasus ini, operasi pembaruan terbaru mungkin selesai lebih dulu. Akibatnya, informasi shadow saat ini bukanlah informasi shadow terbaru. Kami menyarankan agar Anda mempertahankan versi device shadow pada perangkat lokal. Saat memanggil operasi ini, gunakan aplikasi lokal untuk mendapatkan versi terbaru device shadow.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	ID instans container elastis. Anda dapat melihat ID instans tersebut pada halaman Overview di Konsol Platform IoT. Penting Jika instans Anda memiliki ID, Anda harus menentukan ID tersebut untuk parameter ini. Jika tidak, pemanggilan akan gagal. Jika halaman Overview atau ID tidak dibuat untuk instans Anda, Anda tidak perlu mengonfigurasi parameter ini. Untuk informasi selengkapnya, lihat Overview.
DeltaUpdate	Boolean	No	false	Menentukan apakah akan melakukan Pembaruan penuh atau pembaruan inkremental pada parameter desired. Nilai yang valid: true: melakukan pembaruan inkremental. false: melakukan Pembaruan penuh. Ini adalah nilai default.

Selain parameter permintaan spesifik operasi di atas, Anda harus mengonfigurasi parameter permintaan umum saat memanggil operasi ini. Untuk informasi selengkapnya tentang parameter permintaan umum, lihat Common parameters.

Parameter respons

Parameter	Type	Example	Description
Code	String	iot.system.SystemException	Kode kesalahan yang dikembalikan jika pemanggilan gagal. Untuk informasi selengkapnya, lihat Error codes.
ErrorMessage	String	A system exception occurred.	Pesan kesalahan yang dikembalikan jika pemanggilan gagal.
RequestId	String	6754C0E7-A35D-4CC8-A684-45EB1F0008D9	ID permintaan.
Success	Boolean	true	Menunjukkan apakah pemanggilan berhasil. Nilai yang valid: true: Pemanggilan berhasil. false: Pemanggilan gagal.

Contoh

Contoh permintaan

https://iot.cn-shanghai.aliyuncs.com/?Action=UpdateDeviceShadow
&ProductKey=a1T27vz****
&DeviceName=device1
&ShadowMessage={"method":"update","state":{"desired":{"color":"green"}},"version":1}
&<Common request parameters>

Contoh respons sukses

XML format

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

JSON format

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

Kode kesalahan

Untuk daftar kode kesalahan, lihat Service error codes.