文档

GetDeviceInfo - 获取设备数据

更新时间:

查询账号激活场站的设备信息。

接口说明

  • 通过采集终端设备 id,查询设备参数,如果是通过校验,可以查询接口信息,如果不是,返回空值。
  • 需要按天维度的时间,及对单个设备进行查询。如果数据不存在,则返回空值。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/external/getDeviceInfo

请求参数

名称类型必填描述示例值
factoryIdstring

场站 id

pn_95
deviceIdstring

设备 id

pn_69873
dsstring

时间字符串,时间格式为 YYYY-mm-dd

2022-07-26

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 ID

83A5A7DD-8974-5769-952E-590A97BEA34E
httpCodeinteger

http 状态码

200
codestring

请求返回 code,Success 代表请求成功,其他情况代表请求不成功,具体错误原因描述可通过 msg 查看。

Success
successboolean

请求是否成功

true
dataobject

返回信息

deviceIdstring

设备 id

pn_69873
deviceNamestring

设备名称

主变4#
firstTypeNamestring

表计一级类型

电表
secondTypeNamestring

表计二级类型

关口表
recordListobject []

参数列表

statisticsDatestring

统计日期

2022-07-26 00:00:00
paramNamestring

参数名称

A相电流
unitstring

单位

A
identifierstring

设备标识符

Ia
typestring

测点类型

DOUBLE
valuedouble

数值

20.00

示例

正常返回示例

JSON格式

{
  "requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E",
  "httpCode": 200,
  "code": "Success",
  "success": true,
  "data": {
    "deviceId": "pn_69873",
    "deviceName": "主变4#",
    "firstTypeName": "电表",
    "secondTypeName": "关口表",
    "recordList": [
      {
        "statisticsDate": "2022-07-26 00:00:00",
        "paramName": "A相电流",
        "unit": "A",
        "identifier": "Ia",
        "type": "DOUBLE",
        "value": 20
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400invalidParameterInvalid parameter values.请求参数错误,请检查方法入参
401notAuthorizedNo permissions to call API operations.该账号没有API调用权限
500systemErrorSystem error.系统错误

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-04-17OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:400
    新增错误码:401
    新增错误码:500
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈