更新时间：2024-07-01 GMT+08:00

查询产品列表

功能介绍

应用服务器可调用此接口查询已导入物联网平台的产品模型信息列表，了解产品模型的概要信息。

URI

GET /v5/iotps/{project_id}/products

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。最小长度：1 最大长度：32

表2 Query参数
参数	是否必选	参数类型	描述
limit	否	Integer	分页查询时每页显示的记录数，默认值为10，取值范围为1-50的整数。最小值：1 最大值：50 缺省值：10
marker	否	String	上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。缺省值：999999999999999999999999 最小长度：24 最大长度：24
region_id	是	String	区域ID，用于区分不同的区域。最小长度：1 最大长度：64
access_point_id	是	String	接入点id，用于区分不同的区域。最小长度：1 最大长度：64
app_id	否	String	应用id。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，可以携带该参数查询指定资源空间下的产品列表，不携带该参数则会查询该用户下所有产品列表。最小长度：1 最大长度：64
access_key	否	String	鉴权接入名。最小长度：0 最大长度：256

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
products	Array of ProductSummary objects	产品信息列表。数组长度：0 - 100
page	Page object	查询结果的分页信息。

表5 ProductSummary
参数	参数类型	描述
product_id	String	产品ID，用于唯一标识一个产品模型，在物联网平台的SP Portal上导入产品模型后由平台分配获得。最小长度：0 最大长度：64
name	String	产品名称。最小长度：0 最大长度：255
device_type	String	设备类型。最小长度：0 最大长度：255
model	String	设备型号。最小长度：0 最大长度：255
protocol_type	String	设备使用的协议类型。最小长度：0 最大长度：20
industry	String	设备所属行业。最小长度：0 最大长度：255
description	String	产品的描述信息。最小长度：0 最大长度：2048

表6 Page
参数	参数类型	描述
count	Long	满足查询条件的记录总数，最大返回1000条记录。最小值：0 最大值：1000
marker	String	本次分页查询结果中最后一条记录的ID，可在下一次分页查询时使用。最小长度：0 最大长度：64

请求示例

无

响应示例

状态码： 200

Successful response

{
  "products" : [ {
    "product_id" : "5ba24f5ebbe8f56f5a14f605",
    "name" : "Thermometer",
    "device_type" : "Thermometer",
    "model" : "123",
    "protocol_type" : "LWM2M",
    "industry" : "smartCity",
    "description" : "this is a thermometer produced by Huawei"
  } ],
  "page" : {
    "count" : 100,
    "marker" : "5c8f3d2d3df1f10d803adbda"
  }
}