QueryProductList - IoT Platform

使用說明

調用本介面時，如果指定頁數“CurrentPage”大於查詢結果的總頁數“PageCount”，返回的“ProductInfo”會為空白。此時，您可以根據返回結果總條數“Total”，重新指定“CurrentPage”和“PageSize”，再次調用介面查看產品資訊。

例如：假設查詢結果共20條，請求參數“PageSize”為5，查詢結果總頁數“PageCount”會為20÷5=4頁，“CurrentPage”設定為1、2、3或4時，“ProductInfo”才會有產品具體資訊。如果“CurrentPage”大於4，例如為5，第5頁是沒有資料的，此時“ProductInfo”就會為空白。

返回樣本如下：

{
  "RequestId": "62F56B4D-9CBC-518A-8414-CC91BB83FD04",
  "Data": {
    "PageCount": 4,
    "PageSize": 5,
    "CurrentPage": 5,
    "Total": 20,
    "List": {
      "ProductInfo": []
    }
  },
  "Code": "",
  "Success": true
}

QPS限制

單個阿里雲帳號調用該介面的每秒請求數（QPS）最大限制為50。
說明單個阿里雲帳號下的所有RAM使用者共用該阿里雲帳號的配額。
當請求參數CurrentPage與PageSize的值相乘結果大於或等於100000時，會降低調用該介面的QPS。

此時，單個阿里雲帳號調用該介面的每秒請求數（QPS）最大限制為2。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	QueryProductList	系統規定參數。取值：QueryProductList。
CurrentPage	Integer	是	1	指定顯示返回結果中的第幾頁。
PageSize	Integer	是	2	指定返回結果中每頁顯示的產品數量，最大值是200。
IotInstanceId	String	否	iot_instc_pu***_c-v64********	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。
ResourceGroupId	String	否	rg-acfmxazb4ph****	資源群組ID。重要目前，物聯網平台僅支援執行個體維度資源群組管理。請求參數ResourceGroupId配置已無效，無需再傳入。
AliyunCommodityCode	String	否	iothub_senior	指定要查看的產品類型，取值： iothub_senior：使用物模型版產品。 iothub：不使用物模型版產品。說明如果不傳入該參數，則返回所有產品的列表。

調用API時，除了本文介紹的該API的特有請求參數，還需傳入公用請求參數。公用請求參數說明，請參見公用參數文檔。

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
Data	Struct		調用成功時，返回的產品資訊。具體資訊請參見以下參數。
CurrentPage	Integer	1	當前頁號。
List	Array of ProductInfo		產品資訊列表。說明返回的產品資訊按照產品建立時間倒序排列。
ProductInfo
AuthType	String	secret	產品下的裝置接入物聯網平台的認證方式。 secret：使用裝置密鑰進行裝置身份認證。 id2：使用物聯網裝置身份認證ID²。 x509：使用裝置X.509認證進行裝置身份認證。
DataFormat	Integer	1	裝置與雲端之間的資料通訊協定類型。該參數為使用物模型的產品（AliyunCommodityCode=iothub_senior）的特有參數。取值： 0：透傳模式。使用自訂的串口資料格式。該模式下，裝置可以上報未經處理資料（如位元據流）。阿里雲物聯網平台會運行您配置在雲端的資料解析指令碼，將未經處理資料轉換成Alink JSON標準資料格式。 1：Alink JSON。阿里雲物聯網平台定義的裝置與雲端的資料交換協議，採用JSON格式。
Description	String	This is a test product.	產品描述。
DeviceCount	Integer	128	產品下的裝置數量。
GmtCreate	Long	1581595942000	該產品的建立時間。毫秒值時間戳記。
NodeType	Integer	0	產品的節點類型。該參數為使用物模型的產品（AliyunCommodityCode=iothub_senior）的特有參數。取值： 0：裝置。裝置不能掛載子裝置，可以直連IoT Hub，也可以作為網關的子裝置串連IoT Hub。 1：網關。網關可以掛載子裝置，具有子裝置管理模組，維持子裝置的拓撲關係，並且可以將拓撲關係同步到雲端。
ProductKey	String	a1T27vz****	產品的ProductKey。建立產品時，物聯網平台為該產品頒發的全域唯一標識。
ProductName	String	路燈	產品名稱。
PageCount	Integer	92	總頁數。
PageSize	Integer	2	每頁顯示的產品數。
Total	Integer	184	產品總數。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
RequestId	String	4B4ECF2C-6222-42EC-A4B5-C12202E71CEA	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	是否調用成功。 true：表示調用成功。 false：表示調用失敗。

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryProductList
&CurrentPage=1
&PageSize=2
&ResourceGroupId=rg-acfmxazb4ph****
&<公用請求參數>

正常返回樣本

XML格式

<QueryProductListResponse>
  <Data>
        <PageCount>92</PageCount>
        <PageSize>2</PageSize>
        <List>
              <ProductInfo>
                    <DataFormat>1</DataFormat>
                    <ProductKey>a1A0D4t****</ProductKey>
                    <NodeType>0</NodeType>
                    <ProductName>路燈產品</ProductName>
                    <DeviceCount>1</DeviceCount>
                    <GmtCreate>1569233025000</GmtCreate>
                    <AuthType>secret</AuthType>
              </ProductInfo>
              <ProductInfo>
                    <DataFormat>1</DataFormat>
                    <ProductKey>a1dEvuQ****</ProductKey>
                    <NodeType>0</NodeType>
                    <ProductName>子裝置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": "路燈產品", 
          "DeviceCount": 1, 
          "GmtCreate": 1569233025000, 
          "AuthType": "secret"
        }, 
        {
          "DataFormat": 1, 
          "ProductKey": "a1dEvuQ****", 
          "NodeType": 0, 
          "ProductName": "子裝置custom", 
          "DeviceCount": 0, 
          "GmtCreate": 1568690432000,
          "AuthType": "secret"
        }
      ]
    }, 
    "CurrentPage": 1, 
    "Total": 184
  }, 
  "RequestId": "4B4ECF2C-6222-42EC-A4B5-C12202E71CEA", 
  "Success": true
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。