调用该接口根据标签分页查询产品列表。

使用说明

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