QueryProduct - IoT Platform - Alibaba Cloud Documentation Center

Mengkueri detail suatu produk.

Batasan

Setiap Akun Alibaba Cloud dapat menjalankan maksimal 50 kueri 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	Wajib	Contoh	Deskripsi
Action	String	Ya	QueryProduct	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke QueryProduct.
ProductKey	String	Ya	a1BwAGV****	ProductKey dari produk yang ingin Anda kueri. ProductKey adalah GUID yang dikeluarkan oleh IoT Platform untuk suatu produk. Anda dapat menggunakan Konsol IoT Platform atau memanggil operasi QueryProductList untuk melihat informasi semua produk dalam akun saat ini.
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, pemanggilan akan gagal. Jika instans Anda tidak memiliki halaman Overview atau ID, Anda tidak perlu menyetel parameter ini. Untuk informasi selengkapnya, lihat Overview.

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

Parameter respons

Parameter	Type	Contoh	Deskripsi
Code	String	iot.system.SystemException	Kode kesalahan yang dikembalikan jika pemanggilan gagal. Untuk informasi selengkapnya, lihat Error codes.
Data	Struct		Informasi produk yang dikembalikan jika pemanggilan berhasil.
AliyunCommodityCode	String	iothub_senior	Tipe produk. Parameter ini menunjukkan apakah model Thing Specification Language (TSL) digunakan. Nilai yang valid: iothub_senior: Model TSL digunakan. iothub: Model TSL tidak digunakan.
AuthType	String	secret	Metode autentikasi yang digunakan untuk menghubungkan perangkat produk ke IoT Platform. Nilai yang valid: secret: DeviceSecret digunakan untuk mengautentikasi perangkat. id2: IoT Internet Device ID digunakan untuk mengautentikasi perangkat. x509: Sertifikat X.509 digunakan untuk mengautentikasi perangkat.
CategoryKey	String	Lighting	Identifier kategori tempat produk tersebut termasuk. Parameter ini dikembalikan jika produk menggunakan model TSL dari kategori standar yang telah ditentukan sebelumnya oleh IoT Platform. Parameter ini tersedia jika parameter AliyunCommodityCode disetel ke iothub_senior.
CategoryName	String	Street Lamp	Nama kategori produk. Parameter ini dikembalikan jika produk menggunakan model TSL dari kategori standar yang telah ditentukan sebelumnya oleh IoT Platform. Parameter ini tersedia jika parameter AliyunCommodityCode disetel ke iothub_senior.
DataFormat	Integer	1	Format data yang digunakan oleh protokol komunikasi untuk mentransmisikan data antara perangkat dan IoT Platform. Parameter ini tersedia jika parameter AliyunCommodityCode disetel ke iothub_senior. Nilai yang valid: 0: custom. Format data serial kustom digunakan. Dalam kasus ini, perangkat dapat mengirimkan data mentah, seperti aliran data biner. IoT Platform mengonversi data mentah menjadi data JSON Alink standar menggunakan skrip penguraian data tertentu. 1: Alink JSON. Data JSON Alink ditransmisikan antara perangkat dan IoT Platform. Alink adalah protokol pertukaran data yang telah ditentukan sebelumnya oleh IoT Platform.
Description	String	Smart street light	Deskripsi produk.
DeviceCount	Integer	0	Jumlah perangkat di bawah produk tersebut.
GmtCreate	Long	1581595942000	Waktu saat produk dibuat. Nilainya berupa timestamp dalam milidetik.
Id2	Boolean	false	Menunjukkan apakah IoT Internet Device ID diaktifkan. Nilai yang valid: true: IoT Internet Device ID diaktifkan. false: IoT Internet Device ID dinonaktifkan.
NetType	Integer	3	Metode koneksi jaringan. Nilai yang valid: 3: Wi-Fi. 6: jaringan seluler (2G/3G/4G/5G). 7: Ethernet. 8: lainnya.
NodeType	Integer	0	Tipe node produk. Parameter ini tersedia jika parameter AliyunCommodityCode disetel ke iothub_senior. Nilai yang valid: 0: device. Perangkat sub tidak dapat disambungkan ke perangkat. Perangkat dapat terhubung langsung ke IoT Platform atau sebagai perangkat sub dari gerbang. 1: gateway. 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 produk. true: ya. false: tidak.
ProductKey	String	a1T27vz****	ProductKey produk. Saat Anda membuat produk, ProductKey adalah identifier unik global (GUID) yang dikeluarkan oleh IoT Platform untuk produk tersebut.
ProductName	String	Street light	Nama produk.
ProductSecret	String	U5tW7i44uilc****	ProductSecret produk.
ProductStatus	String	DEVELOPMENT_STATUS	Status produk. DEVELOPMENT_STATUS: Produk sedang dalam pengembangan. RELEASE_STATUS: Produk telah dipublikasikan.
ProtocolType	String	modbus	Tipe protokol yang digunakan oleh perangkat sub untuk terhubung dengan gerbang. Parameter ini tersedia jika parameter AliyunCommodityCode disetel ke iothub_senior dan parameter NodeType disetel ke 1. Nilai yang valid: modbus: Modbus. opc-ua: OPC UA. customize: protokol kustom. ble: BLE. zigbee: ZigBee.
ValidateType	Integer	1	Tingkat verifikasi data. Nilai yang valid: 2: tanpa verifikasi. IoT Platform tidak memverifikasi data. Semua data diteruskan. Di Konsol IoT Platform, data tidak ditampilkan pada tab TSL Data di halaman Detail Perangkat. 1: verifikasi tingkat rendah. IoT Platform hanya memverifikasi bidang identifier dan dataType dari data. Semua data diteruskan. 0: verifikasi tingkat tinggi. IoT Platform memverifikasi semua bidang data. Hanya data yang lolos verifikasi yang diteruskan. Produk yang dibuat sebelum 14 Oktober 2020 hanya mendukung verifikasi tingkat tinggi. Produk yang dibuat pada atau setelah 14 Oktober 2020 mendukung verifikasi tingkat rendah atau tanpa verifikasi. Setelah verifikasi, Anda dapat melihat data yang lolos atau gagal verifikasi. Di Konsol IoT Platform, data ditampilkan pada tab TSL Data di halaman Device Details. Data yang gagal verifikasi tidak ditampilkan. Anda dapat melihat data yang gagal verifikasi dalam parameter checkFailedData dari data yang diteruskan. Untuk informasi selengkapnya, lihat Data formats.
ErrorMessage	String	A system exception occurred.	Pesan kesalahan yang dikembalikan jika pemanggilan gagal.
RequestId	String	E4F94B97-1D64-4080-BFD2-67461667AA43	ID permintaan.
Success	Boolean	true	Menunjukkan apakah pemanggilan berhasil. true: Pemanggilan berhasil. false: Pemanggilan gagal.

Contoh

Contoh permintaan

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryProduct
&ProductKey=a1BwAGV****
&<Common request parameters>

Contoh respons sukses

XML format

<QueryProductResponse>
  <Data>
        <Owner>true</Owner>
        <CategoryName>Street lighting</CategoryName>
        <DataFormat>1</DataFormat>
        <ProductKey>a1BwAGV****</ProductKey>
        <ProductStatus>DEVELOPMENT_STATUS</ProductStatus>
        <GmtCreate>1581595942000</GmtCreate>
        <ProductSecret>U5tW7i44uilc****</ProductSecret>
        <NodeType>0</NodeType>
        <ProductName>Street light</ProductName>
        <ValidateType>1</ValidateType>
        <DeviceCount>0</DeviceCount>
        <NetType>3</NetType>
        <AuthType>secret</AuthType>
        <CategoryKey>Lighting</CategoryKey>
        <Id2>false</Id2>
        <AliyunCommodityCode>iothub_senior</AliyunCommodityCode>
  </Data>
  <RequestId>DA5A3C45-D457-48ED-9A20-AEDEA8503401</RequestId>
  <Success>true</Success>
</QueryProductResponse>

JSON format

{
    "Data": {
        "Owner": true,
        "CategoryName": "Street lighting",
        "DataFormat": 1,
        "ProductKey": "a1BwAGV****",
        "ProductStatus": "DEVELOPMENT_STATUS",
        "GmtCreate": 1581595942000,
        "ProductSecret": "U5tW7i44uilc****",
        "NodeType": 0,
        "ProductName": "Street light"
        "ValidateType":1,
        "DeviceCount": 0,
        "NetType": 3,
        "AuthType": "secret",
        "CategoryKey": "Lighting",
        "Id2": false,
        "AliyunCommodityCode": "iothub_senior"
    },
    "RequestId": "DA5A3C45-D457-48ED-9A20-AEDEA8503401",
    "Success": true
}

Kode kesalahan

Untuk daftar kode kesalahan, kunjungi API Error Center.