Menampilkan semua produk.
Catatan penggunaan
Jika nilai CurrentPage yang Anda tentukan lebih besar daripada nilai PageCount saat memanggil operasi QueryProductList, maka ProductInfo akan kosong. Dalam kasus ini, Anda dapat menentukan nilai baru untuk CurrentPage dan PageSize berdasarkan nilai Total yang dikembalikan, lalu memanggil kembali operasi tersebut untuk mengambil daftar produk.
Sebagai contoh, jika nilai Total yang dikembalikan adalah 20 dan nilai PageSize yang Anda tetapkan adalah 5, maka nilai PageCount yang dikembalikan adalah 4, dihitung dengan rumus: 20 ÷ 5 = 4. Jika Anda menetapkan nilai CurrentPage sebesar 1, 2, 3, atau 4, ProductInfo tidak akan kosong. Namun, jika Anda menetapkan nilai CurrentPage lebih dari 4—misalnya 5—maka ProductInfo akan kosong karena tidak ada data pada halaman tersebut.
Contoh respons sukses:
{
"RequestId": "62F56B4D-9CBC-518A-8414-CC91BB83FD04",
"Data": {
"PageCount": 4,
"PageSize": 5,
"CurrentPage": 5,
"Total": 20,
"List": {
"ProductInfo": []
}
},
"Code": "",
"Success": true
}
Batas QPS
Anda dapat memanggil operasi ini hingga 50 kali per detik per akun.
CatatanPengguna RAM dari Akun Alibaba Cloud berbagi kuota akun tersebut.
Jika hasil perkalian antara nilai CurrentPage dan PageSize lebih besar dari atau sama dengan 100.000, QPS operasi ini akan berkurang.
Dalam kasus ini, setiap Akun Alibaba Cloud hanya dapat menjalankan maksimal 2 QPS.
Debugging
Parameter permintaan
Parameter | Type | Required | Example | Description |
Action | String | Yes | QueryProductList | Operasi yang ingin Anda lakukan. Tetapkan nilainya ke QueryProductList. |
CurrentPage | Integer | Yes | 1 | Nomor halaman. |
PageSize | Integer | Yes | 2 | Jumlah entri per halaman. Nilai valid: 1 hingga 200. |
IotInstanceId | String | No | iot_instc_pu****_c*-v64******** | ID instans. Anda dapat melihat ID instans pada tab Ikhtisar di Konsol IoT Platform. Penting
Untuk informasi selengkapnya, lihat Ikhtisar. |
ResourceGroupId | String | No | rg-acfmxazb4ph**** | ID kelompok sumber daya. Penting IoT Platform hanya memungkinkan Anda menambahkan instans ke dalam kelompok sumber daya. Parameter ResourceGroupId tidak lagi berlaku. Anda tidak perlu mengonfigurasi ResourceGroupId. |
AliyunCommodityCode | String | No | iothub_senior | Tipe produk. Nilai valid:
Catatan Jika Anda tidak menentukan parameter ini, semua produk akan dikembalikan. |
Selain parameter permintaan khusus 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 | Type | Example | Description |
Code | String | iot.system.SystemException | Kode kesalahan yang dikembalikan jika permintaan gagal. Untuk informasi selengkapnya, lihat Kode kesalahan. |
Data | Struct | Informasi produk yang dikembalikan jika pemanggilan berhasil. Untuk informasi selengkapnya, lihat parameter berikut. | |
CurrentPage | Integer | 1 | Nomor halaman. |
List | Array of ProductInfo | Produk yang ditanyakan. Catatan Produk yang ditanyakan diurutkan secara kronologis terbalik berdasarkan waktu pembuatannya. | |
ProductInfo | |||
AuthType | String | secret | Metode verifikasi yang digunakan oleh perangkat produk untuk terhubung ke IoT Platform. Nilai valid:
|
DataFormat | Integer | 1 | Format data yang digunakan oleh protokol komunikasi untuk mentransmisikan data antara perangkat dan IoT Platform. Parameter ini hanya dikembalikan jika AliyunCommodityCode diatur ke iothub_senior. Nilai valid:
|
Description | String | This is a test product. | Deskripsi produk. |
DeviceCount | Integer | 128 | Jumlah perangkat dalam produk. |
GmtCreate | Long | 1581595942000 | Waktu pembuatan produk. Nilai ini merupakan Stempel waktu UNIX yang merepresentasikan jumlah milidetik sejak 1 Januari 1970 pukul 00:00:00 Coordinated Universal Time (UTC). |
NodeType | Integer | 0 | Tipe node produk. Parameter ini hanya dikembalikan jika AliyunCommodityCode diatur ke iothub_senior. Nilai valid:
|
ProductKey | String | a1T27vz**** | KunciProduk produk. KunciProduk adalah ID Unik Global (GUID) yang dikeluarkan oleh IoT Platform untuk suatu produk. |
ProductName | String | Street light | Nama produk. |
PageCount | Integer | 92 | Total jumlah halaman yang dikembalikan. |
PageSize | Integer | 2 | Jumlah entri per halaman. |
Total | Integer | 184 | Total jumlah produk. |
ErrorMessage | String | A system exception occurred. | Pesan kesalahan yang dikembalikan jika pemanggilan gagal. |
RequestId | String | 4B4ECF2C-6222-42EC-A4B5-C12202E71CEA | ID permintaan. |
Success | Boolean | true | Menunjukkan apakah pemanggilan berhasil. Nilai valid:
|
Contoh
Contoh permintaan
https://iot.cn-shanghai.aliyuncs.com/?Action=QueryProductList
&CurrentPage=1
&PageSize=2
&ResourceGroupId=rg-acfmxazb4ph****
&<Common request parameters>Contoh respons sukses
XML format
<QueryProductListResponse>
<Data>
<PageCount>92</PageCount>
<PageSize>2</PageSize>
<List>
<ProductInfo>
<DataFormat>1</DataFormat>
<ProductKey>a1A0D4t****</ProductKey>
<NodeType>0</NodeType>
<ProductName>Street light</ProductName>
<DeviceCount>1</DeviceCount>
<GmtCreate>1569233025000</GmtCreate>
<AuthType>secret</AuthType>
</ProductInfo>
<ProductInfo>
<DataFormat>1</DataFormat>
<ProductKey>a1dEvuQ****</ProductKey>
<NodeType>0</NodeType>
<ProductName>Custom sub-device</ProductName>
<DeviceCount>0</DeviceCount>
<GmtCreate>1568690432000</GmtCreate>
<AuthType>secret</AuthType>
</ProductInfo>
</List>
<CurrentPage>1</CurrentPage>
<Total>184</Total>
</Data>
<RequestId>4B4ECF2C-6222-42EC-A4B5-C12202E71CEA</RequestId>
<Success>true</Success>
</QueryProductListResponse>JSON format
{
"Data": {
"PageCount": 92,
"PageSize": 2,
"List": {
"ProductInfo": [
{
"DataFormat": 1,
"ProductKey": "a1A0D4t****",
"NodeType": 0,
"ProductName": "Street light",
"DeviceCount": 1,
"GmtCreate": 1569233025000,
"AuthType": "secret"
},
{
"DataFormat": 1,
"ProductKey": "a1dEvuQ****",
"NodeType": 0,
"ProductName": "Custom sub-device",
"DeviceCount": 0,
"GmtCreate": 1568690432000,
"AuthType": "secret"
}
]
},
"CurrentPage": 1,
"Total": 184
},
"RequestId": "4B4ECF2C-6222-42EC-A4B5-C12202E71CEA",
"Success": true
}Kode kesalahan
Untuk daftar kode kesalahan, lihat Service error codes.