V2.5 Search DPS Device¶
搜索满足条件的 DPS 设备。
使用此 API 前,确保已安装 EnOS 2.4 CU2 或更新版本。
请求格式¶
POST https://{apigw-address}/dps-service/v2.5/pvs/device?action=search
请求参数(URI)¶
名称 | 位置(Path/Query) | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|---|
orgId | Query | 必需 | String | 设备所属的组织 ID。如何获取 orgId 信息>> |
请求参数(Body)¶
名称 | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|
expression | 必需 | String | 查询表达式,支持 FQL 查询。目前支持的字段有
|
pagination | 可选 | Pagination 请求结构体 | 随机分页。如未指定,默认每页 10 条。每页最大记录数为 1,000 条,但为获得最佳性能,建议每页不超过 50 条。支持使用 sorters 参数对结果进行排序,默认按照 createTime 进行排序,最近创建的将靠前排列。Pagination 请求结构体>> |
响应参数¶
名称 | 数据类型 | 描述 |
---|---|---|
data | PvsDevice 结构体数组 | DPS 设备的信息。更多信息,参见 PvsDevice 结构体。 |
PvsDevice 结构体 ¶
名称 | 数据类型 | 描述 |
---|---|---|
sn | String | 系统生成的设备 SN 号,环境内唯一。 |
groupId | String | 注册组 ID。 |
regionId | String | 设备被分配至的 region ID。 |
orgId | String | 设备被分配至的组织 ID。 |
productKey | String | 设备在 EnOS 管理控制台 中对应的 product key。 |
batchOrder | Integer | 设备创建批次编号。 |
batchTag | StringI18n | 设备创建批次标签。国际化名称表示方法 >> |
deviceData | Map | 设备主数据。 |
desc | String | 设备描述。 |
status | PvsDeviceStatus 结构体 | 设备当前状态。更多信息,参见 PvsDeviceStatus 结构体。 |
reprovisioning | Boolean |
|
allocateErrorMsg | String | 设备上一次的分配失败信息。 |
createBy | String | 创建人的用户 ID。 |
createTime | Long | 设备的创建时间。 |
updateBy | String | 更新人的用户 ID。 |
updateTime | Long | 设备的修改时间。 |
manufacturerOrgId | String | 设备预注册的组织 ID。 |
connectStatus | String | 设备的连接状态,包含 init 、connected 和 failed 。 |
allocateStatus | String | 设备的分配状态,包含 init 和 allocated 。 |
PvsDeviceStatus 结构体 ¶
名称 | 数据类型 | 描述 |
---|---|---|
currentStatus | String | 设备当前状态,包含 init 、allocated 、connected 、finished 和 discarded 。 |
connectedTime | Long | 设备的连接时间。 |
allocatedTime | Long | 设备的分配时间。 |
finishedTime | Long | 设备激活完成的时间。 |
discardedTime | Long | 设备废弃的时间。 |
示例¶
请求示例¶
url: https://{apigw-address}/dps-service/v2.5/pvs/device?action=search
method: POST
requestBody:
{
"expression": "sn = 'sn1' || deviceData.commDeviceSn in ('InverterTest_update','InverterTest','Inverter') && deviceData.regionId = 'region1'",
"pagination": {
"pageNo": 1,
"pageSize": 10,
"sorters": [{
"field": "deviceData.deviceSn",
"order": "ASC"
}]
}
}
返回示例¶
{
"code": 0,
"msg": "OK",
"requestId": "ee3e2bc8-4595-490d-88d4-72bfe86b66cd",
"data": [
{
"sn": "sn1",
"groupId": "groupId",
"regionId": null,
"orgId": null,
"productKey": "productKey",
"batchOrder": 583,
"batchTag": {
"defaultValue": "batch_update",
"i18nValue": {
"en_US": "batch_update",
"zh_CN": "批量更新"
}
},
"deviceData": {
"date": "2023-06-08",
"commDeviceSn": "InverterTest_update",
"seqNo": 1,
"topoSize": 5,
"modelID": "modelID_update",
"optModel": "optModel_update",
"deviceSn": "devicesn",
"version": "version_update",
"enum": "CENTRAL",
"capacity": 20.2,
"modelName": "modelName_update",
"capacity_rated": 200.2,
"assetId": "assetId",
"parentDeviceSn": "InverterTest1_update",
"regcode": "regcode_update",
"optIndex": [
"optIndex1_update",
"optIndex2_update",
"optIndex3_update"
],
"tokenInUse": "tokenInUse_update",
"optVersion": "optVersion_update",
"optSN": [
"optSN1_update",
"optSN2_update"
]
},
"desc": "DCM AutoTest Desc_update",
"status": {
"currentStatus": "init",
"connectedTime": null,
"allocatedTime": null,
"finishedTime": null,
"discardedTime": null
},
"reprovisioning": true,
"allocateErrorMsg": "",
"createBy": null,
"createTime": 1690184441964,
"updateBy": null,
"updateTime": 1690184441964,
"manufacturerOrgId": "manufacturerOrgId1",
"connectStatus": "init",
"allocateStatus": "init"
},
{
"sn": "sn2",
"groupId": "groupId",
"regionId": null,
"orgId": null,
"productKey": null,
"batchOrder": 587,
"batchTag": {
"defaultValue": "batch_update",
"i18nValue": {
"en_US": "batch_en_us_update",
"zh_CN": "batch_zh_cn_update"
}
},
"deviceData": {
"date": "2023-06-09",
"commDeviceSn": "InverterTest_update",
"seqNo": 1,
"topoSize": 5,
"modelID": "modelID_update",
"timezone": null,
"optModel": "optModel_update",
"deviceSn": "deviceSn2",
"version": "version_update",
"deviceName": {
"i18nValue": {}
},
"enum": "STRING",
"orgId": "orgId",
"capacity": 20,
"modelName": "modelName_update",
"capacity_rated": 200,
"regionId": "beta",
"parentDeviceSn": "InverterTest1_update",
"regcode": "regcode_update",
"optIndex": [
"optIndex1_update",
"optIndex2_update",
"optIndex3_update"
],
"tokenInUse": "tokenInUse_update",
"optVersion": "optVersion_update",
"tokenReplacing": null,
"optSN": [
"optSN1_update",
"optSN2_update"
]
},
"desc": "Desc_update",
"status": {
"currentStatus": "init",
"connectedTime": null,
"allocatedTime": null,
"finishedTime": null,
"discardedTime": null
},
"reprovisioning": false,
"allocateErrorMsg": null,
"createBy": null,
"createTime": 1690184442292,
"updateBy": null,
"updateTime": 1690184442292,
"manufacturerOrgId": "manufacturerOrgId2",
"connectStatus": "init",
"allocateStatus": "init"
}
],
"pagination": {
"sortedBy": [
{
"field": "deviceData.deviceSn",
"order": "ASC"
}
],
"pageNo": 1,
"pageSize": 10,
"totalSize": 2
}
}