查询设备列表

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的整数。

zone_code

否

String

参数说明：空间编码。

取值范围：长度为1-32，只允许大小写字母、数字、#、_、.和-的组合。

device_type

否

String

参数说明：设备类型。

取值范围：IOTDA-云端物联网类 IOTEDGE-边侧物联网。

X-Auth-Token

是

String

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

X-Instance-Id

是

String

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

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

X-Root-Zone-Id

否

String

参数说明：项目ID。

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

devices

Array of BaseDeviceInfo objects

参数说明：设备列表。

page

Page object

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

zone_id

String

参数说明：区域ID。

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

zone_code

String

参数说明：空间编码。

取值范围：长度为1-32，只允许大小写字母、数字、#、_、.和-的组合。

zone_name

String

参数说明：区域名称。

取值范围：长度不超64。

product_id

String

参数说明：产品ID。

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

product_name

String

参数说明：产品名称。

取值范围：长度不超64。

product_code

String

参数说明：产品编码。

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

brand_id

String

参数说明：品牌ID。

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

brand_name

String

参数说明：品牌名称。

取值范围：长度不超64。

device_id

String

参数说明：设备ID。

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

gateway_id

String

参数说明：网关设备ID。

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

parent_device_id

String

参数说明：父设备ID。用于标识设备所属的父设备，即父设备的设备ID。

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

node_id

String

参数说明：设备标识码，通常使用IMEI、MAC地址或SN号作为node_id。

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

device_name

String

参数说明：设备名称。

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

device_description

String

参数说明：设备描述。

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

device_status

String

参数说明：设备状态。

取值范围：

• ONLINE：设备在线。

• OFFLINE：设备离线。

• ABNORMAL：设备异常。

• INACTIVE：设备未激活。

• FROZEN：设备冻结。

manufacturer_info

ManufacturerInfo object

厂商信息。

extension_info

Map<String,String>

参数说明：设备扩展信息。最多填写10个扩展字段。

取值范围：

总大小不能超过1KB。

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

value取值长度不超过256，只允许中文、字母、数字、点号、以及_-字符的组合。

device_type

String

参数说明：设备类型。

取值范围：VIDEO-摄像头类 SCREEN-智慧屏类 IOTDA-云端物联网类 IOTEDGE-边侧物联网类。

device_sub_type

String

参数说明：设备子类型。

取值范围：仅当device_type为IOTEDGE时填写，GATEWAY表示网关类型，ELEC表示机电设备，HlinkG表示HlinkG设备，CONTROLLER表示控制器设备。

spec_properties

Array of SpecProperty objects

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

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

create_time

String

参数说明：创建时间.

取值范围："yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"。

device_report_period

Integer

参数说明：设备上报周期。

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

root_zone_id

String

参数说明：根区域ID。

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

manufacturer_name

String

参数说明：设备厂商。

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

manufacturer_code

String

参数说明：设备厂商编码。

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

model

String

参数说明：设备型号。

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

property_code

String

参数说明：属性编码。

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

property_value

Object

参数说明：属性值。

count

Long

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

marker

String

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

取值范围：长度0-64。

error_code

String

参数说明：错误码。

取值范围：长度8-36。

error_msg

String

参数说明：错误描述。

取值范围：长度2-512。

200

OK

400

Bad Request