調用該接口根據標簽分頁查詢產品列表。

使用說明

  • 支持按照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": "傳感器"
			}
		]
	}
}