SetDeviceProperty - IoT Platform - Alibaba Cloud Documentation Center

Menetapkan nilai properti suatu Perangkat.

Catatan penggunaan

Setelah Platform IoT mengirim permintaan untuk mengonfigurasi properti Perangkat, Perangkat menerima dan memproses permintaan tersebut secara asinkron. Respons sukses dari pemanggilan operasi ini hanya menunjukkan bahwa Platform IoT telah mengirim permintaan, bukan bahwa Perangkat telah menerima dan memprosesnya. Properti Perangkat akan dikonfigurasi setelah SDK Perangkat merespons permintaan tersebut.

Penting Jika data Thing Specification Language (TSL) bertipe float atau double, nilai parameter yang sesuai harus mengandung setidaknya satu tempat desimal. Contoh: 10.0 dan 11.1.

Batas QPS

Anda dapat memanggil operasi API ini hingga 500 kali per detik per Akun Alibaba Cloud.

Catatan Pengguna RAM dalam suatu Akun Alibaba Cloud berbagi Kuota akun tersebut.

Debugging

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

Parameter permintaan

Parameter	Tipe	Wajib	Contoh	Deskripsi
Action	String	Ya	SetDeviceProperty	Operasi yang ingin Anda lakukan. Tetapkan nilai ke SetDeviceProperty.
Items	String	Ya	{"Switch":1,"Color":"blue"}	Properti yang ingin Anda konfigurasikan. Properti tersebut harus dalam format JSON. Setiap properti terdiri atas kombinasi identifier properti dan nilai properti dalam format kunci:nilai. Pisahkan multiple properti dengan koma (,). Sebagai contoh, Anda dapat mengonfigurasi properti berikut untuk lampu pintar: Properti sakelar dengan kunci Switch dan tipe data BOOLEAN. Nilainya adalah 1. Nilai 1 menunjukkan bahwa lampu menyala. Properti warna dengan kunci Color dan tipe data STRING. Nilainya adalah blue. Dalam kasus ini, Anda dapat mengonfigurasi properti berikut dalam format JSON: `Items={"Switch":1,"Color":"blue"}` Catatan Jika Anda mengonfigurasi properti untuk modul kustom testFb, tentukan `Items={"testFb:Switch":1,"testFb:Color":"blue"}`. Modul testFb bukan modul default.
IotInstanceId	String	Tidak	iot-v64*****	ID instans. Anda dapat melihat ID instans pada halaman Overview di konsol IoT Platform. Penting Jika instans Anda memiliki ID, Anda harus menentukan ID tersebut untuk parameter ini. Jika tidak, panggilan akan gagal. Jika tidak ada halaman Overview atau ID yang dihasilkan untuk instans Anda, Anda tidak perlu mengonfigurasi parameter ini. Untuk informasi selengkapnya, lihat Overview.
ProductKey	String	Tidak	a1BwAGV****	ProductKey dari produk tempat perangkat tersebut terdaftar. Penting Jika Anda menentukan nilai untuk parameter ini, Anda harus mengonfigurasi parameter DeviceName.
DeviceName	String	Tidak	light	NamaPerangkat dari perangkat tersebut. Penting Jika Anda mengonfigurasi parameter ini, Anda harus menentukan nilai untuk parameter ProductKey.
IotId	String	Tidak	Q7uOhVRdZRRlDnTLv****00100	ID perangkat. ID ini merupakan pengenal unik yang dikeluarkan oleh IoT Platform untuk perangkat tersebut. Penting Parameter IotId menentukan sebuah GUID untuk perangkat. Nilai parameter IotId setara dengan kombinasi nilai parameter ProductKey dan DeviceName. Jika Anda menentukan nilai untuk parameter IotId, Anda tidak perlu menentukan nilai untuk parameter ProductKey dan DeviceName. Jika Anda menentukan nilai untuk parameter IotId, ProductKey, dan DeviceName, nilai parameter IotId akan didahulukan.
Qos	Integer	Tidak	1	Tingkat kualitas layanan (QoS) dari pesan tersebut. Nilai yang valid: 0 (default): Sistem mengirim pesan paling banyak satu kali. 1: Sistem mengirim pesan paling sedikit satu kali. Jika tanggapan PUBACK tidak dikembalikan setelah Anda memublikasikan pesan QoS 1, pesan tersebut akan dikirim ulang ke Perangkat saat Perangkat terhubung kembali ke Platform IoT.

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 Parameter Umum.

Parameter respons

Parameter	Tipe	Contoh	Deskripsi
Code	String	iot.system.SystemException	Kode kesalahan yang dikembalikan jika panggilan gagal. Untuk informasi selengkapnya, lihat Error codes.
Data	Struct		Data yang dikembalikan jika panggilan berhasil.
MessageId	String	abcabc123	ID dari paket yang dikirim oleh IoT Platform ke perangkat.
ErrorMessage	String	A system exception occurred.	Pesan error yang dikembalikan jika panggilan gagal.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	ID dari permintaan tersebut.
Success	Boolean	true	Menunjukkan apakah panggilan berhasil. Nilai yang valid: true: Panggilan berhasil. false: Panggilan gagal.

Contoh

Contoh permintaan

https://iot.cn-shanghai.aliyuncs.com/?Action=SetDeviceProperty
&ProductKey=a1BwAGV****
&DeviceName=device1
&Items={"Switch":1,"Color":"blue"}
&<Common request parameters>

Contoh respons sukses

XML format

<SetDevicePropertyResponse>
  <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
  <Success>true</Success>
  <Data>
        <MessageId>abcabc123</MessageId>
  </Data>
</SetDevicePropertyResponse>

JSON format

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

Kode kesalahan

Untuk daftar kode kesalahan, lihat Kode Kesalahan Layanan.