查询空压站列表
功能介绍
查询空压站列表
URI
GET /v1/iotfm/energy-eff/compressor-sites
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| 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的整数。 | 
| site_id | 否 | String | 空压站ID | 
| site_name | 否 | String | 空压站名称 | 
| calendar_id | 否 | String | 日历ID | 
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| 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,只允许字母、数字的组合。 | 
响应参数
状态码:200
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| X-Request-Id | String | This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. | 
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| compressor_sites | Array of QueryCompressorSiteBaseRsp objects | 空压站列表 | 
| page | Page object | 查询批量分页结构体,定义了分页页码、每页记录数、记录总数、该页记录的最大ID。 | 
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| site_name | String | 空压站名称。长度不超过64,只允许中文、字母、数字、以及_-等字符的组合。 | 
| site_description | String | 空压站描述。长度不超过256,只允许中文、字母、数字、以及_-等字符的组合。 | 
| site_id | String | 空压站ID。长度不超过36,只允许字母、数字、以及_-等字符的组合。 | 
| zone_id | String | 区域ID | 
| calendar_id | String | 日历ID | 
| ba_config_url | String | 组态图页面地址,以智能设施云平台 Console域名开头,长度不超过255。 | 
| config | CompressorSiteConfig object | 冷站配置。 | 
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| calendar_id | String | 日历ID | 
| min_running_cop | Double | 最小运行COP。 | 
| eff_calc_config | CompressorSiteEffCalcConfig object | 空压站节能计算参数。 | 
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| eff_calc_start_time | String | 参数说明:节能计算开始时间。 取值范围:格式为:"yyyy-MM-dd''T''HH:mm:ss.SSS''Z''"。 | 
| eff_calc_base_value | Double | 计算节能率的基准值 | 
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| count | Long | 参数说明:本次分页查询结果中,获取的记录总数。 | 
| marker | String | 参数说明:本次分页查询结果中最后一条记录的ID,可在下一次分页查询时使用。 取值范围:长度0-64。 | 
状态码:400
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| X-Request-Id | String | This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. | 
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| error_code | String | 参数说明:错误码。 取值范围:长度8-36。 | 
| error_msg | String | 参数说明:错误描述。 取值范围:长度2-512。 | 
请求示例
无
响应示例
无
状态码
| 状态码 | 描述 | 
|---|---|
| 200 | 查询空压站列表响应体 | 
| 400 | Error response | 
错误码
请参见错误码。
 
  