QueryDeviceInfo - IoT Platform - Alibaba Cloud Documentation Center

Mengkueri informasi dasar perangkat tertentu, termasuk ID perangkat, sertifikat perangkat, dan alias.

Batasan

Setiap Akun Alibaba Cloud dapat menjalankan hingga 500 kueri per detik (QPS).

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

Debugging

Alibaba Cloud menyediakan OpenAPI Explorer untuk menyederhanakan penggunaan API. 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	Tipe	Wajib	Contoh	Deskripsi
Action	String	Ya	QueryDeviceInfo	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke QueryDeviceInfo.
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 Anda memiliki ID, Anda harus mengonfigurasi parameter ini. Jika Anda tidak menyetel parameter ini, panggilan akan gagal. Jika instans Anda tidak memiliki halaman Overview atau ID, Anda tidak perlu menyetel parameter ini. Untuk informasi selengkapnya, lihat Overview.
ProductKey	String	Tidak	a1BwAGV****	KunciProduk dari Produk tempat Perangkat tersebut terdaftar. Penting Jika Anda menentukan parameter ini, Anda juga harus menentukan parameter DeviceName.
DeviceName	String	Tidak	light	NamaPerangkat dari perangkat tersebut. Penting Jika Anda menentukan parameter ini, Anda juga harus menentukan parameter ProductKey.
IotId	String	Tidak	Q7uOhVRdZRRlDnTLv****00100	ID Perangkat. Penting Jika Anda menentukan parameter ini, Anda tidak perlu menentukan ProductKey atau DeviceName. Parameter IotId menentukan identifier unik global (GUID) dari perangkat, yang berkorespondensi dengan kombinasi ProductKey dan DeviceName. Jika Anda menentukan IotId serta kombinasi ProductKey dan DeviceName sekaligus, IotId akan diutamakan.

Selain parameter permintaan khusus operasi di atas, Anda harus menentukan parameter permintaan umum saat memanggil operasi ini. Untuk informasi selengkapnya, lihat Parameter permintaan 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		Informasi mengenai perangkat yang dikembalikan jika panggilan berhasil.
DeviceName	String	light	NamaPerangkat dari Perangkat tersebut.
DeviceSecret	String	mz2Canp4GB7qRVf1OYPNtRqB2anu****	RahasiaPerangkat dari perangkat tersebut.
IotId	String	Q7uOhVRdZRRlDnTLv****00100	ID perangkat. ID ini merupakan pengenal unik yang dikeluarkan oleh IoT Platform untuk perangkat tersebut.
Nickname	String	detectors_in_beijing	Alias dari perangkat.
ProductKey	String	a1rYuVF****	KunciProduk dari produk tempat perangkat tersebut terdaftar.
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 atau tidak. true: Panggilan berhasil. false: Panggilan gagal.

Contoh

Contoh permintaan

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceInfo
&ProductKey=a1rYuVF****
&DeviceName=light
&<Common request parameters>

Contoh respons sukses

XML format

<QueryDeviceInfoResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <IotId>Q7uOhVRdZRRlDnTLv****00100</IotId>
        <DeviceSecret>mz2Canp4GB7qRVf1OYPNtRqB2anu****</DeviceSecret>
        <ProductKey>a1rYuVF****</ProductKey>
        <Nickname>detectors_in_beijing</Nickname>
        <DeviceName>light</DeviceName>
  </Data>
  <Success>true</Success>
</QueryDeviceInfoResponse>

JSON format

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "IotId": "Q7uOhVRdZRRlDnTLv****00100",
        "DeviceSecret": "mz2Canp4GB7qRVf1OYPNtRqB2anu****",
        "ProductKey": "a1rYuVF****",
        "Nickname": "detectors_in_beijing",
        "DeviceName": "light"
    },
    "Success": true
}

Kode kesalahan

HttpCode	Kode kesalahan	Pesan kesalahan	Deskripsi
200	Iot.common.QueryDeviceActionError	An error occurred while querying the device.	Pesan kesalahan yang dikembalikan karena sistem gagal melakukan kueri informasi perangkat.

Untuk daftar kode kesalahan, kunjungi API Error Center.