查询产品列表

limit

否

Integer

参数说明：分页查询时每页显示的记录数。

取值范围：默认值为10，取值范围为1-50的整数。

marker

否

String

参数说明：上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。

取值范围：长度固定24，只允许大小写字母、数组的组合。

offset

否

Integer

参数说明：表示从marker后偏移offset条记录开始查询。当offset为0时，表示从marker后第一条记录开始输出。限制offset最大值是出于API性能考虑，您可以搭配marker使用该参数实现翻页，例如每页50条记录，1-11页内都可以直接使用offset跳转到指定页，但到11页后，由于offset限制为500，您需要使用第11页返回的marker作为下次查询的marker，以实现翻页到12-22页。

取值范围：默认为0，取值范围为0-500的整数。

category_id

否

String

参数说明：产品分类ID。

取值范围：长度不超过36，只允许字母、数字、以及_$-字符的组合。产品分类编码与产品分类ID，只能二选一，优先分类ID。

category_code

否

String

参数说明：产品分类编码。

取值范围：长度不超过36，只允许字母、数字、以及_-字符的组合。产品分类编码与产品分类ID，只能二选一，优先分类ID。

product_id

否

String

参数说明：产品ID。

取值范围：长度不超过36，只允许字母、数字、以及_-字符的组合。

product_code

否

String

参数说明：产品编码。

取值范围：长度不超过48，只允许字母、数字、以及_-.字符的组合。

product_name

否

String

参数说明：产品名称。

取值范围：长度不超过64，只允许中文、字母、数字、以及_-字符的组合。

product_short_code

否

String

参数说明：产品简码。

取值范围：长度不超过24，只允许字母、数字的组合。

use_recursive_for_category

否

Boolean

参数说明：是否递归查询当前产品分类下子分类的所有产品

is_show_detail

否

Boolean

参数说明：是否返回产品详细信息

X-Auth-Token

是

String

参数说明：用户Token。通过调用 生成Token 接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。

X-Instance-Id

是

String

参数说明：实例ID。通过访问智能设施云平台界面后获取，智能设施云平台资源均为实例级隔离，所有业务接口必须填写正确的实例ID才能被成功调用。

取值范围：长度8-36，只允许大小写字母、数字和-字符的组合。

products

Array of QueryProductRsp objects

参数说明：产品列表。

page

Page object

查询批量分页结构体，定义了分页页码、每页记录数、记录总数、该页记录的最大ID。

product_code

String

参数说明：产品编码。

取值范围：长度不超过48，只允许字母、数字、以及_.-字符的组合。

product_short_code

String

参数说明：产品简码。

取值范围：长度不超过24，只允许大写字母、数字的组合。

product_name

String

参数说明：产品名称。

取值范围：长度不超过64，只允许中文、字母、数字、以及_-字符的组合。

protocol_type

String

参数说明：设备使用的协议类型。

取值范围：MQTT，CoAP，HTTP，HTTPS，Modbus，ONVIF，OPC-UA，OPC-DA，Other。"

product_description

String

参数说明：产品详情描述。

取值范围：长度不超过128，只允许中文、字母、数字、以及_-字符的组合。

category_id

String

参数说明：产品分类ID。

取值范围：长度不超过36，只允许字母、数字、以及_$-字符的组合。

category_code

String

参数说明：产品分类编码。

取值范围：长度不超过36，只允许字母、数字、以及_-字符的组合。

product_id

String

参数说明：产品ID。

取值范围：长度不超过36，只允许字母、数字、以及_-字符的组合。

is_system

Boolean

参数说明：是否为系统内部产品。

取值范围：true|false。

service_capabilities

Array of ServiceCapabilityDef objects

参数说明：服务列表。

取值范围：数组长度不超过500，且文本内容长度不超过128KB。

def_properties

Array of SpecPropertyDef objects

参数说明：设备规格属性列表。

取值范围：数组长度不超过500，且文本内容长度不超过128KB。

access_type

String

参数说明：接入类型。

取值范围：长度不超过36，只允许字母、数字、以及_-字符的组合。

service_id

String

参数说明：服务ID。产品内唯一。

取值范围：长度不超过64，只允许字母、数字、以及_?'#().,&%@!\-字符的组合。

properties

Array of ServicePropertyDef objects

参数说明：设备属性列表。

取值范围：数组长度不超过500。

commands

Array of ServiceCommandDef objects

参数说明：设备命令列表。

取值范围：数组长度不超过500。

events

Array of ServiceEventDef objects

参数说明：设备事件列表。

取值范围：数组长度不超过500。

property_code

String

参数说明：属性编码。

取值范围：长度不超过40，只允许英文字母大小写、数字、下划线的组合。

property_name

String

参数说明：属性名称。

取值范围：长度不超过40，只允许英文字母大小写、数字以及_?'#()\[\]=℃.,;&%@!\- ，、：；。￥$！【】’‘“”（）？…~/字符的组合。

data_type

String

参数说明：数据类型。

取值范围：字符串-String 整数-Integer 小数-Decimal 布尔-Boolean 枚举-Enumeration 日期时间-Datetime Json对象-Json

unit

String

参数说明：单位。

取值范围：只允许中文、英文字母大小写、数字、下划线、数字上标、Greek and Coptic、CJK Compatibility、斜杆、·℃°%等字符的组合。

property_priority

Integer

参数说明：设施点位控制优先级。

取值范围：只允许数字，设施云priority范围：8-16。

default_value

Object

参数说明：设备属性默认值，根据data_type的类型设置。

collect_period

Integer

参数说明：设备属性采集周期。

取值范围：只允许数字，单位：秒，范围：5-86400(24小时)。

enum_list

Array of objects

参数说明：枚举值列表，字符串数组或者{value，display}的对象数组。

取值范围：数组长度不超过100，单字符串长度不超过128。

method

String

参数说明：访问权限。R-属性值可读 W-属性值可写 RW-属性值可读可写。

取值范围：只允许R，W，RW。

property_component_name

String

参数说明：属性组件名，默认为空，即不使用系统组件定义；使用组件定义时，填入该组件名称。

command_code

String

参数说明：命令编码。

取值范围：长度不超过40，只允许英文字母大小写、数字、下划线的组合。

command_name

String

参数说明：命令中文名称。

取值范围：长度不超过40，只允许中文、英文字母大小写、数字、下划线的组合。

invoke_type

String

参数说明：调用方式，同步-SYNC 异步-ASYNC。

取值范围：只允许SYNC，ASYNC。

command_paras

Array of ServiceCommandParaDef objects

参数说明：命令参数。

command_responses

Array of ServiceCommandResponseDef objects

参数说明：命令响应列表。

response_code

String

参数说明：命令响应编码。

取值范围：长度不超过128，只允许英文字母大小写、数字、下划线的组合。

response_paras

Array of ServiceCommandParaDef objects

参数说明：命令响应的参数列表。

event_type

String

参数说明：设备事件类型。设备服务内不允许重复。

取值范围：长度不超过32，只允许英文字母大小写、数字、下划线的组合。

paras

Array of ServiceCommandParaDef objects

参数说明：设备事件的参数列表。

para_code

String

参数说明：参数标识符。

取值范围：长度不超过32，只允许字母、数字、以及_?''#().,&%@!-字符的组合。

para_name

String

参数说明：参数名称。

取值范围：长度不超过40，只允许中文、英文字母大小写、数字、下划线的组合。

data_type

String

参数说明：数据类型。

取值范围：字符串-String 整数-Integer 小数-Decimal 布尔-Boolean 枚举-Enumeration 日期时间-Datetime Json对象-Json。

unit

String

参数说明：单位。

取值范围：只允许中文、英文字母大小写、数字、下划线、数字上标、Greek and Coptic、CJK Compatibility、斜杆、·℃°%字符的组合。

min

String

参数说明：参数的最小值。

max

String

参数说明：参数的最大值。

enum_list

Array of strings

参数说明：枚举值列表。

property_code

String

参数说明：属性编码。

取值范围：长度不超过40，只允许英文字母大小写、数字、下划线的组合。

property_name

String

参数说明：属性名称。

取值范围：长度不超过40，只允许中文、英文字母大小写、数字、下划线的组合。

data_type

String

参数说明：数据类型。

取值范围：字符串-String 整数-Integer 小数-Decimal 布尔-Boolean 枚举-Enumeration 日期时间-Datetime Json对象-Json。

unit

String

参数说明：单位。

取值范围：只允许中文、英文字母大小写、数字、下划线、数字上标、Greek and Coptic、CJK Compatibility、斜杆、·℃°%字符的组合。

enum_list

Array of objects

参数说明：枚举值列表，字符串数组或者{value，display}的对象数组。

取值范围：数组长度不超过100，单字符串长度不超过128。

count

Long

参数说明：本次分页查询结果中，获取的记录总数。

marker

String

参数说明：本次分页查询结果中最后一条记录的ID，可在下一次分页查询时使用。

取值范围：长度0-64。

error_code

String

参数说明：错误码。

取值范围：长度8-36。

error_msg

String

参数说明：错误描述。

取值范围：长度2-512。

200

OK

400

Bad Request