QueryDeviceDetail - IoT Platform - Alibaba Cloud Documentation Center

Menampilkan detail suatu Perangkat.

Batas QPS

Setiap Akun Alibaba Cloud dapat menjalankan hingga 50 permintaan per detik (QPS).

Catatan Pengguna RAM dari suatu 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	QueryDeviceDetail	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke QueryDeviceDetail.
IotInstanceId	String	No	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, pemanggilan akan gagal. Jika halaman Overview atau ID tidak dibuat untuk instans Anda, Anda tidak perlu mengonfigurasi parameter ini. Untuk informasi selengkapnya, lihat Overview.
ProductKey	String	No	a1BwAGV****	ProductKey Produk tempat Perangkat tersebut terdaftar. Catatan Jika Anda menentukan nilai untuk parameter ini, Anda juga harus menentukan nilai untuk parameter DeviceName.
DeviceName	String	No	light	DeviceName Perangkat tersebut. Catatan Jika Anda menentukan nilai untuk parameter ini, Anda juga harus menentukan nilai untuk parameter ProductKey.
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	ID Perangkat tersebut. Catatan Jika Anda menentukan nilai untuk parameter ini, Anda tidak perlu menentukan nilai untuk parameter ProductKey atau DeviceName. Parameter IotId menentukan ID Unik Global (GUID) untuk Perangkat tersebut. Nilai parameter IotId sesuai dengan kombinasi nilai parameter ProductKey dan DeviceName. Jika Anda menentukan nilai untuk parameter IotId sekaligus nilai untuk parameter ProductKey dan DeviceName, nilai parameter IotId akan didahulukan.

Selain parameter permintaan khusus operasi di atas, Anda harus menentukan parameter permintaan umum saat memanggil operasi ini. Untuk informasi selengkapnya, lihat Common request 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.
Data	Struct		Detail Perangkat yang dikembalikan jika pemanggilan berhasil.
DeviceName	String	light	DeviceName Perangkat tersebut.
DeviceSecret	String	mz2Canp4GB7qRVf1OYPNtRqB2anu****	DeviceSecret Perangkat tersebut.
FirmwareVersion	String	V1.0.0.0	Nomor versi modul OTA default Perangkat tersebut. Jika Anda ingin menanyakan informasi versi modul OTA lainnya, panggil operasi ListOTAModuleVersionsByDevice. Informasi versi tersebut dikirimkan oleh Perangkat.
GmtActive	String	2018-08-06 10:48:41	Waktu saat Perangkat diaktifkan. Waktu dalam format GMT.
GmtCreate	String	2018-08-06 10:47:50	Waktu saat Perangkat dibuat. Waktu dalam format GMT.
GmtOnline	String	2018-08-06 13:43:12	Waktu paling baru saat Perangkat online. Waktu dalam format GMT.
IotId	String	Q7uOhVRdZRRlDnTLv****00100	ID Perangkat tersebut. ID ini merupakan pengenal unik yang dikeluarkan oleh IoT Platform untuk Perangkat tersebut.
IpAddress	String	10.0.0.1	Alamat IP Perangkat tersebut.
Nickname	String	detectors_in_beijing	Alias Perangkat tersebut.
NodeType	Integer	0	Jenis node. Nilai yang valid: 0: Perangkat. Perangkat sub tidak dapat disambungkan ke Perangkat. Perangkat dapat terhubung langsung ke IoT Platform atau sebagai Perangkat sub dari gerbang. 1: gerbang. Perangkat sub dapat disambungkan ke gerbang. Gerbang dapat mengelola Perangkat sub, mempertahankan hubungan topologis dengan Perangkat sub, dan menyinkronkan hubungan topologis tersebut ke IoT Platform.
Owner	Boolean	true	Menunjukkan apakah operasi dipanggil oleh Pemilik Perangkat tersebut.
ProductKey	String	a1rYuVF****	ProductKey Produk tempat Perangkat tersebut terdaftar.
ProductName	String	test	Nama Produk tempat Perangkat tersebut terdaftar.
Region	String	cn-shanghai	ID Wilayah tempat Perangkat tersebut berada. Wilayah ini sama dengan Wilayah tempat IoT Platform berada. Anda dapat melihat wilayah tersebut di Konsol IoT Platform.
Status	String	ONLINE	Status Perangkat. Nilai yang valid: ONLINE: Perangkat sedang online. OFFLINE: Perangkat sedang offline. UNACTIVE: Perangkat belum diaktifkan. DISABLE: Perangkat dinonaktifkan.
UtcActive	String	2018-08-06T02:48:41.000Z	Waktu saat Perangkat diaktifkan. Waktu dalam format UTC.
UtcCreate	String	2018-08-06T02:47:50.000Z	Waktu saat Perangkat dibuat. Waktu dalam format UTC.
UtcOnline	String	2018-08-06T05:43:12.000Z	Waktu paling baru saat Perangkat online. Waktu dalam format UTC.
ErrorMessage	String	A system exception occurred.	Pesan kesalahan yang dikembalikan jika pemanggilan gagal.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	ID permintaan.
Success	Boolean	true	Menunjukkan apakah pemanggilan berhasil. true: Pemanggilan berhasil. false: Pemanggilan gagal.

Contoh

Permintaan contoh

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceDetail
&ProductKey=a1rYuVF****
&DeviceName=device1
&<Common request parameters>

Respons keberhasilan contoh

XML format

<QueryDeviceDetailResponse>
  <Data>
        <Owner>true</Owner>
        <GmtActive>2020-01-16 13:33:37</GmtActive>
        <DeviceName>Humidity</DeviceName>
        <ProductKey>a1ttsqu****</ProductKey>
        <DeviceSecret>sLefbFmN9SYfnWLJTePG893XNuRV****</DeviceSecret>
        <IpAddress>42.120.75.144</IpAddress>
        <GmtCreate>2020-01-08 14:47:08</GmtCreate>
        <UtcCreate>2020-01-08T06:47:08.000Z</UtcCreate>
        <IotId>dwnS41bhNxjslDAIF****00100</IotId>
        <Status>OFFLINE</Status>
        <UtcOnline>2020-01-17T08:19:11.091Z</UtcOnline>
        <Region>cn-shanghai</Region>
        <UtcActive>2020-01-16T05:33:37.830Z</UtcActive>
        <Nickname>Temperature and humidity</Nickname>
        <NodeType>0</NodeType>
        <GmtOnline>2020-01-17 16:19:11</GmtOnline>
        <ProductName>Light, temperature, and humidity sensor
  </Data>
  <RequestId>D2D2DE90-DD0F-44EA-9F56-63F07A59F65B</RequestId>
  <Success>true</Success>
</QueryDeviceDetailResponse>

JSON format

{
	"Data": {
		"Owner": true,
		"GmtActive": "2020-01-16 13:33:37",
		"DeviceName": "Humidity",
		"ProductKey": "a1ttsqu****",
		"DeviceSecret": "sLefbFmN9SYfnWLJTePG893XNuRV****",
		"IpAddress": "42.120.75.144",
		"GmtCreate": "2020-01-08 14:47:08",
		"UtcCreate": "2020-01-08T06:47:08.000Z",
		"IotId": "dwnS41bhNxjslDAIF****00100",
		"Status": "OFFLINE",
		"UtcOnline": "2020-01-17T08:19:11.091Z",
		"Region": "cn-shanghai",
		"UtcActive": "2020-01-16T05:33:37.830Z",
		"NickName": "Temperature and humidity",
		"NodeType": 0,
		"GmtOnline": "2020-01-17 16:19:11",
		"ProductName": "Light, temperature, and humidity sensor"
	},
	"RequestId": "D2D2DE90-DD0F-44EA-9F56-63F07A59F65B",
	"Success": true
}

Kode kesalahan

Untuk daftar kode kesalahan, kunjungi API Error Center.