用户下采集器接口文档
用户下采集器列表
接口描述
用户下采集器列表
请求方法
/sol_monitor/collector/user/list
请求方式
GET
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| keyWord | query | string | 是 | 设备别名/SN/所属电站 |
| communicationStatus | query | string | 是 | 通讯状态 |
| page | query | string | 是 | 分页 |
| pageSize | query | string | 是 | 页码 |
| serviceExpirationTime | query | string | 是 | 服务到期时间 |
| surplusTraffic | query | string | 是 | 物联网卡流量 |
| serviceExpirationTimeSort | query | string | 是 | 服务到期时间升序降序 |
| surplusTrafficSort | query | string | 是 | 物联网卡流量升序降序 |
| brandId | query | string | 是 | 设备品牌 |
| modelId | query | string | 是 | 设备型号 |
| x-access-token | header | string | 是 | 用户 token |
枚举值
| 属性 | 值 |
|---|---|
| serviceExpirationTimeSort | 1 |
| serviceExpirationTimeSort | 0 |
| surplusTrafficSort | 1 |
| surplusTrafficSort | 0 |
返回示例
{
"success": true,
"message": "操作成功!",
"code": 200,
"result": {
"content": [
{
"id": 11216,
"createTime": "2025-01-05 22:03:01",
"updateTime": "2025-01-24 10:46:57",
"collectorSn": "202211290798",
"name": "202211290798(逆变器,电表)",
"brandId": 1819,
"modelId": 1305,
"collectorModel": "通用",
"collectorBrand": "新耀(优得)",
"simCardNumber": null,
"messageType": null,
"communicationStatus": 0,
"machinesOnlineNum": null,
"firmwareVersion": null,
"keepYears": null,
"keepMonths": null,
"keepDaily": null,
"expireTime": null,
"plantId": 43503,
"plantName": "联盛-辽宁大连金峰轴承1.3706MWp工商业电站",
"dataAccessTime": "2025-01-03 17:47:01",
"deviceCount": 4,
"dataUpdateTime": "2025-01-24 10:46:18",
"scopeUseId": null,
"scopeUseName": null,
"simOnlineStatus": null,
"simProductCapacity": null,
"simCapacityUnit": null,
"simTrafficLeft": null,
"simExpirationDate": null,
"keepStartTime": null,
"keepEndTime": null,
"createSource": null,
"forwardPhotos": null,
"forwardPhotosUploadStatus": null,
"assetsViewStatus": null,
"areaDivideId": null,
"areaDivideName": null,
"collectorStatus": null,
"trafficAlarmFlag": false,
"expirationDateFlag": false,
"deviceImage": null,
"hasQuota": 1
}
],
"pageable": {
"sort": {
"sorted": false,
"unsorted": true,
"empty": true
},
"pageSize": 20,
"pageNumber": 0,
"offset": 0,
"unpaged": false,
"paged": true
},
"totalElements": 113,
"totalPages": 6,
"last": false,
"first": true,
"sort": {
"sorted": false,
"unsorted": true,
"empty": true
},
"numberOfElements": 20,
"size": 20,
"number": 0,
"empty": false
},
"timestamp": 1737687137920
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 | | ----------------------- | -------- | ----- | ---- | ------------------ | ------------------------------------------------ | --------------------- | | » success | boolean | true | | 请求是否成功 | | | » message | string | true | | 请求结果的提示消息 | | | » code | integer | true | | 请求状态码 | | | » result | object | true | | 返回结果 | | | »» content | [object] | true | | | | | »»» updateTime | string | false | | 数据更新时间 | | | »»» collectorSn | string | false | | 设备 sn | | | »»» name | string | false | | 设备别名 | | | »»» brandId | integer | false | | 品牌 id | | | »»» modelId | integer | false | | 型号 id | | | »»» collectorModel | string | false | | 采集器型号 | | | »»» collectorBrand | string | false | | 采集器品牌 | | | »»» simCardNumber | null | false | | sim 卡卡号 | | | »»» communicationStatus | integer | false | | 通讯状态 | 3:正常通讯 2:部分中断 1 或空值或 null:全部中断 | | »»» keepYears | null | false | | 质保年 | | | »»» keepMonths | null | false | | 质保月 | | | »»» keepDaily | null | false | | 质保日 | | | »»» plantId | integer | false | | 电站 id | | | »»» plantName | string | false | | 电站名称 | | | »»» deviceCount | integer | false | | 关联设备数量 | | | »»» dataUpdateTime | string | false | | 数据更新时间 | | | »»» simOnlineStatus | null | false | | sim 卡状态 | | | »»» simProductCapacity | null | false | | 全部流量 | | | »»» simTrafficLeft | null | false | | sim 卡剩余流量 | | | »»» assetsViewStatus | null | false | | 视图标记状态 | 0 | null:未标记 1: 已标记 | | »» totalElements | integer | true | | 数据总数量 | |
用户下采集器设备列表
接口描述
用户下采集器设备列表
请求方法
/sol_monitor/collector/plant/list
请求方式
POST
Body 请求参数
{
"plantId": 43503,
"page": 1,
"pageSize": 10000,
"keyWord": ""
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| Content-Type | header | string | 是 | ||
| x-access-token | header | string | 是 | 用户 token | |
| body | body | object | 否 | ||
| » plantId | body | integer | 是 | 所属电站 id | |
| » page | body | integer | 是 | 分页 | |
| » pageSize | body | integer | 是 | 页码 |
返回示例
{
"success": true,
"message": "操作成功!",
"code": 200,
"result": {
"content": [
{
"id": 11217,
"createTime": "2025-01-05 22:03:12",
"updateTime": "2025-01-24 11:16:39",
"collectorSn": "202207025022",
"name": "202207025022(逆变器1,2)",
"brandId": 1819,
"modelId": 1305,
"collectorModel": "通用",
"collectorBrand": "新耀(优得)",
"simCardNumber": "",
"messageType": null,
"communicationStatus": 0,
"machinesOnlineNum": null,
"firmwareVersion": null,
"keepYears": null,
"keepMonths": null,
"keepDaily": null,
"expireTime": null,
"plantId": 43503,
"plantName": null,
"dataAccessTime": "2025-01-03 17:48:41",
"deviceCount": 9,
"dataUpdateTime": "2025-01-24 11:16:25",
"scopeUseId": null,
"scopeUseName": null,
"simOnlineStatus": null,
"simProductCapacity": null,
"simCapacityUnit": null,
"simTrafficLeft": null,
"simExpirationDate": null,
"keepStartTime": null,
"keepEndTime": null,
"createSource": null,
"forwardPhotos": null,
"forwardPhotosUploadStatus": null,
"assetsViewStatus": null,
"areaDivideId": null,
"areaDivideName": null,
"collectorStatus": null,
"trafficAlarmFlag": false,
"expirationDateFlag": false,
"deviceImage": null,
"hasQuota": null
}
],
"pageable": {
"sort": {
"sorted": false,
"unsorted": true,
"empty": true
},
"pageSize": 10000,
"pageNumber": 0,
"offset": 0,
"unpaged": false,
"paged": true
},
"totalElements": 4,
"totalPages": 1,
"last": true,
"first": true,
"sort": {
"sorted": false,
"unsorted": true,
"empty": true
},
"numberOfElements": 4,
"size": 10000,
"number": 0,
"empty": false
},
"timestamp": 1737688898332
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » success | boolean | true | 请求是否成功 | ||
| » message | string | true | 请求结果的提示消息 | ||
| » code | integer | true | 请求状态码 | ||
| » result | object | true | 返回结果 | ||
| »» content | [object] | true | |||
| »»» id | integer | false | id | ||
| »»» createTime | string | false | 创建时间 | ||
| »»» updateTime | string | false | 最新更新时间 | ||
| »»» collectorSn | string | false | 设备 SN | ||
| »»» name | string | false | 设备别名 | ||
| »»» brandId | integer | false | 品牌 id | ||
| »»» modelId | integer | false | 型号 id | ||
| »»» collectorModel | string | false | 设备型号 | ||
| »»» collectorBrand | string | false | 设备品牌 | ||
| »»» keepYears | null | false | 质保时长(年) | 对应到期年份 | |
| »»» keepMonths | null | false | 质保时长(月) | 对应到期月份 | |
| »»» keepDaily | null | false | 质保时长(日) | 对应到期日 | |
| »» totalElements | integer | true | 数据总数目 |
用户下采集器详情
接口描述
用户下采集器详情
请求方法
/sol_monitor/collector/detail/{collectorId}
请求方式
GET
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| collectorId | path | integer | 是 | 采集器 id | |
| x-access-token | header | string | 是 | 用户 token |
返回示例
{
"success": true,
"message": "操作成功!",
"code": 200,
"result": {
"id": 11216,
"createTime": "2025-01-05 22:03:01",
"updateTime": "2025-01-24 13:02:24",
"collectorSn": "202211290798",
"name": "202211290798(逆变器,电表)",
"brandId": 1819,
"modelId": 1305,
"collectorModel": "通用",
"collectorBrand": "新耀(优得)",
"simCardNumber": "",
"messageType": null,
"communicationStatus": 0,
"machinesOnlineNum": null,
"firmwareVersion": null,
"keepYears": null,
"keepMonths": null,
"keepDaily": null,
"expireTime": null,
"plantId": 43503,
"plantName": null,
"dataAccessTime": "2025-01-03 17:47:01",
"deviceCount": null,
"dataUpdateTime": "2025-01-24 13:01:14",
"scopeUseId": null,
"scopeUseName": null,
"simOnlineStatus": null,
"simProductCapacity": null,
"simCapacityUnit": null,
"simTrafficLeft": null,
"simExpirationDate": null,
"keepStartTime": null,
"keepEndTime": null,
"createSource": null,
"forwardPhotos": null,
"forwardPhotosUploadStatus": null,
"assetsViewStatus": null,
"areaDivideId": null,
"areaDivideName": null,
"collectorStatus": null,
"trafficAlarmFlag": false,
"expirationDateFlag": false,
"deviceImage": "https://zone-monitor.oss-cn-shanghai.aliyuncs.com/temp/%E9%87%87%E9%9B%86%E5%99%A83_1735629621461%281%29_1735870395305.jpg?Expires=1737698890&OSSAccessKeyId=LTAI5tEQjYx5CCj96yRPu1kG&Signature=tE9dNGIsxhTcATlLJxDcMOLfMuQ%3D&x-oss-process=image%2Fresize%2Cm_lfit%2Ch_400%2Cw_400",
"hasQuota": null
},
"timestamp": 1737695290991
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » success | boolean | true | 请求是否成功 | ||
| » message | string | true | 请求结果的提示消息 | ||
| » code | integer | true | 请求状态码 | ||
| » result | object | true | |||
| »» id | integer | true | 设备 id | ||
| »» createTime | string | true | 创建时间 | ||
| »» updateTime | string | true | 最近更新时间 | ||
| »» collectorSn | string | true | 采集器 sn | ||
| »» name | string | true | 设备别名 | ||
| »» brandId | integer | true | 品牌 id | ||
| »» modelId | integer | true | 型号 id | ||
| »» collectorModel | string | true | 设备型号 | ||
| »» collectorBrand | string | true | 设备品牌 | ||
| »» communicationStatus | integer | true | 通讯状态 | 3:正常通讯 2:部分中断 1 或空值或 null:全部中断 | |
| »» keepYears | null | true | 质保时长(年) | 对应到期年份 | |
| »» keepMonths | null | true | 质保时长(月) | 对应到期月份 | |
| »» keepDaily | null | true | 质保时长(日) | 对应到期日 | |
| »» plantId | integer | true | 电站 id |
用户下采集器离线统计
接口描述
用户下采集器离线统计
请求方法
/sol_monitor/collector/offline/statistics
请求方式
GET
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| id | query | string | 是 | 设备 id | |
| isEnergy | query | string | 是 | 对应数据状态 | |
| x-access-token | header | string | 是 | 用户 token |
枚举值
| 属性 | 值 |
|---|---|
| isEnergy | true |
| isEnergy | false |
返回示例
{
"success": true,
"message": "操作成功!",
"code": 200,
"result": {
"yearOfflineList": [
{
"time": "1",
"value": 0,
"apiValue": null,
"year": null,
"month": null,
"day": null,
"allDate": null,
"isnull": null,
"equivalentGenerationHours": null
}
],
"yearOffLine": 0,
"monthOffLine": 0,
"totalOffline": 0,
"weekOffLine": 0
},
"timestamp": 1737695875932
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » success | boolean | true | 请求是否成功 | ||
| » message | string | true | 请求结果的提示消息 | ||
| » code | integer | true | 请求状态码 | ||
| » result | object | true | |||
| »» yearOfflineList | [object] | true | |||
| »»» time | string | false | 日 | ||
| »»» value | integer | false | 离线次数 | ||
| »» yearOffLine | integer | true | 当年离线次数 | ||
| »» monthOffLine | integer | true | 当月离线次数 | ||
| »» totalOffline | integer | true | 全部离线次数 | ||
| »» weekOffLine | integer | true | 本周离线次数 |
用户下采集器故障统计
接口描述
用户下采集器故障统计
请求方法
/sol_monitor/collector/getCollectorAlarmStatistics
请求方式
GET
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| collectorId | query | string | 是 | 采集器 id | |
| x-access-token | header | string | 是 | 用户 token |
返回示例
{
"success": true,
"message": "操作成功!",
"code": 200,
"result": {
"YEAR_DEFAULT_ARR": "[{\"month\":\"1\",\"count\":0.0},{\"month\":\"2\",\"count\":0.0},{\"month\":\"3\",\"count\":0.0},{\"month\":\"4\",\"count\":0.0},{\"month\":\"5\",\"count\":0.0},{\"month\":\"6\",\"count\":0.0},{\"month\":\"7\",\"count\":0.0},{\"month\":\"8\",\"count\":0.0},{\"month\":\"9\",\"count\":0.0},{\"month\":\"10\",\"count\":0.0},{\"month\":\"11\",\"count\":0.0},{\"month\":\"12\",\"count\":0.0}]"
},
"timestamp": 1737696358023
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » success | boolean | true | 请求是否成功 | ||
| » message | string | true | 请求结果的提示消息 | ||
| » code | integer | true | 请求状态码 | ||
| » result | object | true | |||
| »» yearCount | integer | true | 当年故障次数 | ||
| »» YEAR_DEFAULT_ARR | string | true | 故障统计数组 | ||
| »» totalCount | integer | true | 全部故障次数 | ||
| »» weekCount | integer | true | 本周故障次数 | ||
| »» monthCount | integer | true | 当月故障次数 |
用户下采集器故障列表
接口描述
用户下采集器故障列表
请求方法
/sol_monitor/collector/getCollectorAlarmList
请求方式
GET
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| page | query | string | 是 | 分页 | |
| pageSize | query | string | 是 | 页码 | |
| collectorId | query | string | 是 | 采集器 id | |
| x-access-token | header | string | 是 | 用户 token |
返回示例
{
"success": true,
"message": "操作成功!",
"code": 200,
"result": {
"content": [
{
"id": 64704,
"createTime": "2024-03-23 03:00:45",
"updateTime": "2024-04-01 00:00:26",
"alarmNumber": null,
"deviceSn": "898604512419C0910910",
"deviceId": "10886",
"deviceName": "湖州爱侣采集器01",
"plantId": "43082",
"alarmLevel": 1,
"alarmStatus": 2,
"alarmDes": "套餐流量不足150,请及时处理!",
"alarmTime": "2024-03-23 03:00:45",
"alarmEndTime": "2024-04-01 00:00:26",
"plantName": "*爱侣健康科技",
"deviceType": 2,
"errorCode": "143",
"duration": 12779,
"alarmKey": null,
"time": null,
"troubleshootingMethod": null
}
],
"pageable": {
"sort": {
"sorted": false,
"unsorted": true,
"empty": true
},
"pageSize": 10,
"pageNumber": 0,
"offset": 0,
"unpaged": false,
"paged": true
},
"totalElements": 1282,
"totalPages": 129,
"last": false,
"first": true,
"sort": {
"sorted": false,
"unsorted": true,
"empty": true
},
"numberOfElements": 10,
"size": 10,
"number": 0,
"empty": false
},
"timestamp": 1737696688718
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » success | boolean | true | 请求是否成功 | ||
| » message | string | true | 请求结果的提示消息 | ||
| » code | integer | true | 请求状态码 | ||
| » result | object | true | |||
| »» content | [object] | true | |||
| »»» id | integer | false | id | ||
| »»» alarmDes | string | false | 故障描述 | ||
| »»» alarmTime | string | false | 故障时间 | ||
| »»» alarmEndTime | string | false | 修复时间 | ||
| »»» duration | integer | false | 持续时间 | ||
| »» numberOfElements | integer | true | 数据总数目 |
用户下采集器子设备列表
接口描述
用户下采集器子设备列表
请求方法
/sol_monitor/collector/deviceList
请求方式
POST
Body 请求参数
{
"keyWord": "",
"page": 1,
"pageSize": 10,
"collectorId": "11033"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| Content-Type | header | string | 是 | ||
| x-access-token | header | string | 是 | 用户 token | |
| body | body | object | 否 | ||
| » keyWord | body | string | 是 | 设备名称/SN | |
| » page | body | integer | 是 | 分页 | |
| » pageSize | body | integer | 是 | 页码 | |
| » collectorId | body | string | 是 | 采集器 id |
返回示例
{
"success": true,
"message": "操作成功!",
"code": 200,
"result": {
"number": 0,
"last": true,
"numberOfElements": 1,
"size": 10,
"totalPages": 1,
"pageable": {
"paged": true,
"pageNumber": 0,
"offset": 0,
"pageSize": 10,
"unpaged": false,
"sort": {
"unsorted": true,
"sorted": false,
"empty": true
}
},
"sort": {
"unsorted": true,
"sorted": false,
"empty": true
},
"content": [
{
"deviceType": 1,
"alarmStatus": null,
"createTime": "2023-02-19T02:05:20.000+0000",
"communicationType": 0,
"id": 73,
"accessStatus": 1,
"deviceName": "关口表01",
"dataUpdateTime": "2025-01-24T05:35:22.000+0000",
"dataSource": "混合数据",
"deviceSn": "010136062783",
"dataPresentatioSource": null
}
],
"first": true,
"empty": false,
"totalElements": 1
},
"timestamp": 1737697056333
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » success | boolean | true | 请求是否成功 | ||
| » message | string | true | 请求结果的提示消息 | ||
| » code | integer | true | 请求状态码 | ||
| » result | object | true | |||
| »» content | [object] | true | |||
| »»» deviceType | integer | false | 设备类型 | ||
| »»» createTime | string | false | 设备创建时间 | ||
| »»» communicationType | integer | false | 通讯状态 | 2:通讯中断 1:通讯正常 | |
| »»» id | integer | false | id | ||
| »»» accessStatus | integer | false | 接入状态 | 1:已接入 0:未接入 | |
| »»» deviceName | string | false | 设备别名 | ||
| »»» dataUpdateTime | string | false | 数据更新时间 | ||
| »»» deviceSn | string | false | 设备 Sn | ||
| »» totalElements | integer | true | 数据总数目 |