文档

GetDeviceList - 获取设备列表

更新时间:

查询账号激活场站的设备列表。

接口说明

  • 通过场站,查询采集终端设备,如果是通过校验,可以查询接口信息,如果不是,返回空值。
  • 如果场站虚拟表存在,则过滤掉虚拟表。

调试

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

授权信息

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

请求语法

GET /api/external/getDeviceList

请求参数

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

场站 id

pn_95

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 ID

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

返回数据

factoryIdstring

场站 id

pn_95
deviceListobject []

设备列表

deviceIdstring

设备 id

pn_69873
deviceNamestring

设备名称

主变4#
firstTypeNamestring

表计一级类型

电表
secondTypeNamestring

表计二级类型

关口表
parentDevicestring

上级设备

pn_6987
infoobject

设备信息

magnificationinteger

倍率

80
pressureinteger

高低压

0
ptinteger

电压变比值

80
ctinteger

电流变比值

1
constKvainteger

额定容量

100
httpCodeinteger

http 状态码

200
codestring

状态码

Success
successboolean

表示实际请求是否成功

true
httpCodeinteger

http 状态码

200
codestring

状态码

Success
successboolean

表示实际请求是否成功

true

示例

正常返回示例

JSON格式

{
  "requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E",
  "data": {
    "factoryId": "pn_95",
    "deviceList": [
      {
        "deviceId": "pn_69873",
        "deviceName": "主变4#",
        "firstTypeName": "电表",
        "secondTypeName": "关口表",
        "parentDevice": "pn_6987",
        "info": {
          "magnification": 80,
          "pressure": 0,
          "pt": 80,
          "ct": 1,
          "constKva": 100
        }
      }
    ],
    "httpCode": 200,
    "code": "Success",
    "success": true
  },
  "httpCode": 200,
  "code": "Success",
  "success": true
}

错误码

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

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

变更历史

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