GetDeviceList - 获取设备列表

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

接口说明

  • 通过场站,查询采集终端设备,如果是通过校验,可以查询接口信息,如果不是,返回空值。

  • 如果场站虚拟表存在,则过滤掉虚拟表。

  • 目前接入点仅支持杭州energyexpertexternal.cn-hangzhou.aliyuncs.com

  • 使用该接口需要先开通白名单,请通过官网联系我们 进行开通。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

energy:GetDeviceList

list

*全部资源

*

请求语法

GET /api/external/getDeviceList HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

factoryId

string

场站 id

pn_95

返回参数

名称

类型

描述

示例值

object

Schema of Response

requestId

string

请求 ID

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

data

object

返回数据

factoryId

string

场站 id

pn_95

deviceList

array<object>

设备列表

array<object>

设备列表

deviceId

string

设备 id

pn_69873

deviceName

string

设备名称

主变4#

firstTypeName

string

表计一级类型

电表

secondTypeName

string

表计二级类型

关口表

parentDevice

string

上级设备

pn_6987

info

object

设备信息

magnification

integer

倍率

80

pressure

integer

高低压

0

pt

integer

电压变比值

80

ct

integer

电流变比值

1

constKva

integer

额定容量。单位:kVA

100

httpCode

integer

http 状态码

200

code

string

状态码

Success

success

boolean

表示实际请求是否成功

true

httpCode

integer

http 状态码

200

code

string

状态码

Success

success

boolean

表示实际请求是否成功

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

错误码

错误信息

描述

400 invalidParameter Invalid parameter values. 请求参数错误,请检查方法入参
401 notAuthorized No permissions to call API operations. 该账号没有API调用权限
500 systemError System error. 系统错误

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

变更历史

更多信息,参考变更详情