QueryProductList
調(diào)用該接口查看所有產(chǎn)品列表。
使用說明
調(diào)用本接口時,如果指定頁數(shù)“CurrentPage”大于查詢結(jié)果的總頁數(shù)“PageCount”,返回的“ProductInfo”會為空。此時,您可以根據(jù)返回結(jié)果總條數(shù)“Total”,重新指定“CurrentPage”和“PageSize”,再次調(diào)用接口查看產(chǎn)品信息。
例如:假設(shè)查詢結(jié)果共20條,請求參數(shù)“PageSize”為5,查詢結(jié)果總頁數(shù)“PageCount”會為20÷5=4頁,“CurrentPage”設(shè)置為1、2、3或4時,“ProductInfo”才會有產(chǎn)品具體信息。如果“CurrentPage”大于4,例如為5,第5頁是沒有數(shù)據(jù)的,此時“ProductInfo”就會為空。
返回示例如下:
{
"RequestId": "62F56B4D-9CBC-518A-8414-CC91BB83FD04",
"Data": {
"PageCount": 4,
"PageSize": 5,
"CurrentPage": 5,
"Total": 20,
"List": {
"ProductInfo": []
}
},
"Code": "",
"Success": true
}
QPS限制
-
單個阿里云賬號調(diào)用該接口的每秒請求數(shù)(QPS)最大限制為50。
說明 單個阿里云賬號下的所有RAM用戶共享該阿里云賬號的配額。 -
當(dāng)請求參數(shù)CurrentPage與PageSize的值相乘結(jié)果大于或等于100000時,會降低調(diào)用該接口的QPS。
此時,單個阿里云賬號調(diào)用該接口的每秒請求數(shù)(QPS)最大限制為2。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數(shù)
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | QueryProductList | 系統(tǒng)規(guī)定參數(shù)。取值:QueryProductList。 |
CurrentPage | Integer | 是 | 1 | 指定顯示返回結(jié)果中的第幾頁。 |
PageSize | Integer | 是 | 2 | 指定返回結(jié)果中每頁顯示的產(chǎn)品數(shù)量,最大值是200。 |
IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** | 實(shí)例ID。您可在物聯(lián)網(wǎng)平臺控制臺的實(shí)例概覽頁面,查看當(dāng)前實(shí)例的ID。 重要
實(shí)例的更多信息,請參見實(shí)例概述。 |
ResourceGroupId | String | 否 | rg-acfmxazb4ph**** | 資源組ID。 重要 目前,物聯(lián)網(wǎng)平臺僅支持實(shí)例維度的資源組管理。請求參數(shù)ResourceGroupId配置已無效,無需再傳入。
|
AliyunCommodityCode | String | 否 | iothub_senior | 指定要查看的產(chǎn)品類型,取值:
說明 如果不傳入該參數(shù),則返回所有產(chǎn)品的列表。 |
調(diào)用API時,除了本文介紹的該API的特有請求參數(shù),還需傳入公共請求參數(shù)。公共請求參數(shù)說明,請參見公共參數(shù)文檔。
返回數(shù)據(jù)
名稱 |
類型 |
示例值 |
描述 |
Code | String | iot.system.SystemException | 調(diào)用失敗時,返回的錯誤碼。更多信息,請參見錯誤碼。 |
Data | Struct | 調(diào)用成功時,返回的產(chǎn)品信息。具體信息請參見以下參數(shù)。 |
|
CurrentPage | Integer | 1 | 當(dāng)前頁號。 |
List | Array of ProductInfo | 產(chǎn)品信息列表。 說明 返回的產(chǎn)品信息按照產(chǎn)品創(chuàng)建時間倒序排列。 |
|
ProductInfo | |||
AuthType | String | secret | 產(chǎn)品下的設(shè)備接入物聯(lián)網(wǎng)平臺的認(rèn)證方式。
|
DataFormat | Integer | 1 | 設(shè)備與云端之間的數(shù)據(jù)通信協(xié)議類型。該參數(shù)為使用物模型的產(chǎn)品(AliyunCommodityCode=iothub_senior)的特有參數(shù)。 取值:
|
Description | String | This is a test product. | 產(chǎn)品描述。 |
DeviceCount | Integer | 128 | 產(chǎn)品下的設(shè)備數(shù)量。 |
GmtCreate | Long | 1581595942000 | 該產(chǎn)品的創(chuàng)建時間。毫秒值時間戳。 |
NodeType | Integer | 0 | 產(chǎn)品的節(jié)點(diǎn)類型。該參數(shù)為使用物模型的產(chǎn)品(AliyunCommodityCode=iothub_senior)的特有參數(shù)。取值:
|
ProductKey | String | a1T27vz**** | 產(chǎn)品的ProductKey。創(chuàng)建產(chǎn)品時,物聯(lián)網(wǎng)平臺為該產(chǎn)品頒發(fā)的全局唯一標(biāo)識。 |
ProductName | String | 路燈 | 產(chǎn)品名稱。 |
PageCount | Integer | 92 | 總頁數(shù)。 |
PageSize | Integer | 2 | 每頁顯示的產(chǎn)品數(shù)。 |
Total | Integer | 184 | 產(chǎn)品總數(shù)。 |
ErrorMessage | String | 系統(tǒng)異常 | 調(diào)用失敗時,返回的出錯信息。 |
RequestId | String | 4B4ECF2C-6222-42EC-A4B5-C12202E71CEA | 阿里云為該請求生成的唯一標(biāo)識符。 |
Success | Boolean | true | 是否調(diào)用成功。
|
示例
請求示例
https://iot.cn-shanghai.aliyuncs.com/?Action=QueryProductList
&CurrentPage=1
&PageSize=2
&ResourceGroupId=rg-acfmxazb4ph****
&<公共請求參數(shù)>
正常返回示例
XML
格式
<QueryProductListResponse>
<Data>
<PageCount>92</PageCount>
<PageSize>2</PageSize>
<List>
<ProductInfo>
<DataFormat>1</DataFormat>
<ProductKey>a1A0D4t****</ProductKey>
<NodeType>0</NodeType>
<ProductName>路燈產(chǎn)品</ProductName>
<DeviceCount>1</DeviceCount>
<GmtCreate>1569233025000</GmtCreate>
<AuthType>secret</AuthType>
</ProductInfo>
<ProductInfo>
<DataFormat>1</DataFormat>
<ProductKey>a1dEvuQ****</ProductKey>
<NodeType>0</NodeType>
<ProductName>子設(shè)備custom</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
格式
{
"Data": {
"PageCount": 92,
"PageSize": 2,
"List": {
"ProductInfo": [
{
"DataFormat": 1,
"ProductKey": "a1A0D4t****",
"NodeType": 0,
"ProductName": "路燈產(chǎn)品",
"DeviceCount": 1,
"GmtCreate": 1569233025000,
"AuthType": "secret"
},
{
"DataFormat": 1,
"ProductKey": "a1dEvuQ****",
"NodeType": 0,
"ProductName": "子設(shè)備custom",
"DeviceCount": 0,
"GmtCreate": 1568690432000,
"AuthType": "secret"
}
]
},
"CurrentPage": 1,
"Total": 184
},
"RequestId": "4B4ECF2C-6222-42EC-A4B5-C12202E71CEA",
"Success": true
}