ListProductByTags - IoT Platform

使用說明

支援按照TagKey和TagValue組合，或只按照TagKey來搜尋。
傳入多個ProductTag是或的關係。

QPS限制

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

說明 RAM使用者共用阿里雲帳號配額。

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	ListProductByTags	系統規定參數。取值：ListProductByTags。
ProductTag.N.TagKey	String	是	room	產品標籤鍵。
IotInstanceId	String	否	iot-v64***	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。
CurrentPage	Integer	否	1	指定顯示返回結果中的第幾頁。
PageSize	Integer	否	10	指定返回結果中每頁顯示的記錄數量。最大值是50。
ProductTag.N.TagValue	String	否	102	產品標籤值。

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

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
ProductInfos	Array of ProductInfo		調用成功時，返回產品資訊列表（ProductInfo）。說明返回的產品資訊按照產品建立時間倒序排列。
ProductInfo
CreateTime	Long	1545355537000	產品建立時間。
Description	String	This is a test product.	產品描述。
NodeType	Integer	0	產品的節點類型，取值： 0：裝置。裝置不能掛載子裝置。可以直連物聯網平台，也可以作為網關的子裝置串連物聯網平台。 1：網關。網關可以掛載子裝置，具有子裝置管理模組，維持子裝置的拓撲關係，和將拓撲關係同步到物聯網平台。
ProductKey	String	a1BwAGV****	產品的ProductKey。是物聯網平台為建立產品頒發的通用唯一識別碼。
ProductName	String	路燈	產品名稱。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	表示是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=ListProductByTags
&CurrentPage=1
&PageSize=10
&ProductTag.1.TagKey=Reen
&ProductTag.1.TagValue=reen
&ProductTag.2.TagKey=Lock
&ProductTag.2.TagValue=1234
&<公用請求參數>

正常返回樣本

XML格式

<ListProductByTagsResponse>
  <RequestId>09AA366E-81EC-4CF0-B49E-61BCD7C95338</RequestId>
  <Success>true</Success>
  <ProductInfos>
        <ProductInfo>
              <ProductKey>a1BwAGV****</ProductKey>
              <NodeType>0</NodeType>
              <CreateTime>1581595942000</CreateTime>
              <ProductName>路燈</ProductName>
        </ProductInfo>
        <ProductInfo>
              <ProductKey>a1PO***</ProductKey>
              <NodeType>0</NodeType>
              <CreateTime>1580898565000</CreateTime>
              <ProductName>感應器</ProductName>
        </ProductInfo>
  </ProductInfos>
</ListProductByTagsResponse>

JSON格式

{
	"RequestId": "09AA366E-81EC-4CF0-B49E-61BCD7C95338",
	"Success": true,
	"ProductInfos": {
		"ProductInfo": [
			{
				"ProductKey": "a1BwAGV****",
				"NodeType": 0,
				"CreateTime": 1581595942000,
				"ProductName": "路燈"
			},
			{
				"ProductKey": "a1PO***",
				"NodeType": 0,
				"CreateTime": 1580898565000,
				"ProductName": "感應器"
			}
		]
	}
}

錯誤碼

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