GetDeviceShadow - IoT Platform - Alibaba Cloud Documentation Center

Mengambil informasi shadow dari perangkat tertentu.

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	Wajib	Contoh	Deskripsi
Action	String	Tidak	GetDeviceShadow	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke GetDeviceShadow.
DeviceName	String	Tidak	device1	DeviceName perangkat tersebut.
ProductKey	String	Tidak	a1T27vz****	ProductKey produk tempat perangkat tersebut terdaftar.
IotInstanceId	String	Tidak	iot_instc_pu***_c-v64********	ID instans. Anda dapat melihat ID instans pada halaman Overview di Konsol IoT Platform. Penting Jika instans memiliki ID, Anda harus menentukan parameter IotInstanceId. Jika Anda tidak menentukan parameter ini, pemanggilan akan gagal. Jika instans tidak memiliki ID atau halaman Overview tidak ditampilkan, Anda tidak perlu menentukan parameter ini. Untuk informasi selengkapnya, lihat Overview.

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

Parameter respons

Parameter	Type	Contoh	Deskripsi
Code	String	iot.system.SystemException	Kode kesalahan yang dikembalikan jika pemanggilan gagal. Untuk informasi selengkapnya tentang kode kesalahan, lihat Error codes.
ErrorMessage	String	A system exception occurred.	Pesan kesalahan yang dikembalikan jika pemanggilan gagal.
RequestId	String	A56E345A-0978-4993-ACBA-3EF444ED187F	ID permintaan.
ShadowMessage	String	{"method":"update","state":{"desired":{"color":"green"}},"version":1}	Informasi shadow yang dikembalikan jika pemanggilan berhasil. Catatan Struktur informasi shadow bervariasi tergantung pada status perangkat. Untuk informasi selengkapnya, lihat topik Overview tentang Device shadows.
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=GetDeviceShadow
&ProductKey=a1T27vz****
&DeviceName=device1
&<Common request parameters>

Contoh respons sukses

XML format

<GetDeviceShadowResponse>
  <RequestId>A56E345A-0978-4993-ACBA-3EF444ED187F</RequestId>
  <ShadowMessage>{"method":"update","state":{"desired":{"color":"green"}},"version":1}</ShadowMessage>
  <Success>true</Success>
</GetDeviceShadowResponse>

JSON format

{
    "RequestId": "A56E345A-0978-4993-ACBA-3EF444ED187F",
    "ShadowMessage": "{\"method\":\"update\",\"state\":{\"desired\":{\"color\":\"green\"}},\"version\":1}",
    "Success": true
}

Kode kesalahan

Untuk daftar kode kesalahan, lihat Service error codes.