# 查询设备系统列表 #### 功能介绍 查询设备系统列表 #### URI GET /v1/iotfm/ba/device-systems 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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的整数。 | | device_system_id | 否 | String | 设备系统ID。长度不超过36，只允许字母、数字、以及_-字符的组合。 | | device_system_name | 否 | String | 设备系统名称。长度不超过36，只允许中文、字母、数字、以及_-字符的组合。 | | keep_sort | 否 | Boolean | 是否按sortNum排序，默认false, 按设备系统配置记录创建时间倒序排序，若为true时，则device_system_type必填，zone_id为可选参数，忽略其他参数，返回全部结果优先按sortNum升序排序,再按系统名称升序排序 | | device_system_type | 否 | String | - 设备系统类型编码，枚举类型，枚举值由apollo配置项deviceSystem.deviceSystemType配置，默认类型列表为： - ColdAndHeatSourceSystem 冷热源系统 - AirConditioningSystem 空气调节系统 - AirSupplyAndExhaustSystem 送排风系统 - WaterSupplyAndDrainageSystem 给排水系统 - ElevatorControlSystem 梯控系统 - LightingSystem 照明回路系统 - HighVoltageDistributionMonitoring (供配电系统)高压配电监控 - HighVoltageQualityMonitoring (供配电系统)高压电能质量监控 - DCPanelMonitoring (供配电系统)直流屏监控 - TransformerMonitoring (供配电系统)变压器监控 - LowVoltageDistributionMonitoring (供配电系统)低压配电监控 - LowVoltageQualityMonitoring (供配电系统)低压电能质量监控 | | system_ba_type | 否 | String | **参数说明**: 系统组态类型。 **取值范围**: BuildingAutomation-楼宇自控, CenterMonitor-状态集中监视 | | zone_id | 否 | String | 区域ID。长度不超过24，只允许字母、数字、以及_-字符的组合。 | | display_mode | 否 | String | 系统展现形式，枚举值：LIST(列表展示)，DIAGRAM(组态图展示)。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数说明** ：用户Token。通过调用 [生成Token](https://support.huaweicloud.com/api-ocsmartcampus/ocsmartcampus_06_0008.html) 接口获取，接口返回的响应消息头中"X-Subject-Token"就是需要获取的用户Token。 | | X-Instance-Id | 是 | String | **参数说明**：实例ID。通过访问智能设施云平台界面后获取，智能设施云平台资源均为实例级隔离，所有业务接口必须填写正确的实例ID才能被成功调用。 **取值范围**：长度8-36，只允许大小写字母、数字和-字符的组合。 | | X-Root-Zone-Id | 否 | String | **参数说明**：项目ID。 **取值范围**：长度不超过24，只允许字母、数字的组合。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | device_system | Array of [DeviceSystemInfo] objects | 设备系统 | | page | [Page] object | 查询批量分页结构体，定义了分页页码、每页记录数、记录总数、该页记录的最大ID。 | 表4DeviceSystemInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | device_system_name | String | 设备系统名称 | | device_system_id | String | 设备系统ID，长度不超过36，只允许字母、数字、以及_-字符的组合，未指定则自动生成。 | | system_ba_type | String | **参数说明**: 系统组态类型。 **取值范围**: BuildingAutomation-楼宇自控, CenterMonitor-状态集中监视 | | device_system_type | String | - 设备系统类型编码，枚举类型，枚举值由apollo配置项deviceSystem.deviceSystemType配置，默认类型列表为： - ColdAndHeatSourceSystem 冷热源系统 - AirConditioningSystem 空气调节系统 - AirSupplyAndExhaustSystem 送排风系统 - WaterSupplyAndDrainageSystem 给排水系统 - ElevatorControlSystem 梯控系统 - LightingSystem 照明回路系统 - HighVoltageDistributionMonitoring (供配电系统)高压配电监控 - HighVoltageQualityMonitoring (供配电系统)高压电能质量监控 - DCPanelMonitoring (供配电系统)直流屏监控 - TransformerMonitoring (供配电系统)变压器监控 - LowVoltageDistributionMonitoring (供配电系统)低压配电监控 - LowVoltageQualityMonitoring (供配电系统)低压电能质量监控 | | zone_id | String | 区域ID | | zone_name | String | 区域名称 | | display_mode | String | 系统展现形式，枚举值：LIST(列表展示)，DIAGRAM(组态图展示)。 | | selected_product_properties | Array of [ProductPropertiesData] objects | 系统选择的产品及对应属性列表配置信息，当display_mode为LIST类型时该字段必填。JSON格式，整体是一个数组对象，数组中每个元素是一个对象，每个对象表示系统中的某个产品需要展示的属性列表，一个产品下最多选择10个服务，每个服务最多选择10个属性展示 | | ba_config_url | String | 组态图页面地址,以智能设施云平台 Console域名开头，长度不超过255。当display_mode为DIAGRAM类型时该字段必填。 | | sort_num | Integer | 排序, 系统在同一设备类型同一展示形式不同系统的展示顺序 | | remark | String | 备注，描述信息。 | | create_time | String | 创建时间，格式为："yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"。 | | update_time | String | 最后一次修改时间，格式为："yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"。 | 表5ProductPropertiesData | 参数 | 参数类型 | 描述 | |:---|:---|:---| | product_id | String | 产品ID。长度不超过36，只允许字母、数字、以及_-字符的组合。 | | product_name | String | 产品名称 | | property_paths | Array of strings | 产品选择的服务动态属性列表 | 表6Page | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Long | **参数说明**：本次分页查询结果中，获取的记录总数。 | | marker | String | **参数说明**：本次分页查询结果中最后一条记录的ID，可在下一次分页查询时使用。 **取值范围**：长度0-64。 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数说明**：错误码。 **取值范围**：长度8-36。 | | error_msg | String | **参数说明**：错误描述。 **取值范围**：长度2-512。 | #### 请求示例 无 #### 响应示例 无 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询设备系统列表信息成功 | | 400 | 错误请求 |