goodwe-logo开放平台
文档官网

租户名下设备列表查询

接口描述

功能描述

查询租户名下所有的设备列表，如需获取设备实时、历史测点数据，需用设备nodeId，没有nodeId的设备代表无实时、历史测点数据。

访问限制

每个ip的限流次数：每分钟10次。

请求方式

HTTPS调用

POST https://we.goodwe.com/api/openapi/v1/service/getTenantDeviceList

Header参数

属性类型必填说明
AuthorizationString是用户token

请求参数

属性类型必填说明
isGetFirmwareVersionString否是否需要获取设备的固件版本信息（1：需要 0：不需要（默认不需要））
deviceTypesList<String>否设备类型设备类型（Inverter逆变器、ElectricMeter电能表、DataCollector数采远红外、EnvironmentalTester环境检测仪、TemperatureSensor温度传感器、BMS电池系统、Store_PCS储能PCS、Store_BMS电池簇、Store_Pack电池包、Battery_Stack电池堆、EleStoringEquipment储能一体柜、LiquidCooler液冷机、AntiFire消防）(不传默认查全部设备类型) ）
assetScopeInteger否是否包含分享（0：全部；1：租户自身拥有；2：来自其他租户分享（默认1））

返回参数

属性类型说明示例值
codeString请求成功或失败标识，“00000”请求成功，其余code请求失败-
descriptionString请求结果描述-
dataObject返回数据-
data.dataListList<Object>--
data.dataList[].idString设备id1462654953121251328
data.dataList[].nameString设备节点智能电表-1组
data.dataList[].templateCodeString设备类型ElectricMeter
data.dataList[].snString设备名称8100KHTU208G0010
data.dataList[].tenantIdString所属租户id1450742399304253441
data.dataList[].stateString设备状态code1000-运行,1001-待机,1002-故障,1003-停机,1004-休眠,1005-离线,1011-异常
data.dataList[].stateNameString设备状态name1000-运行,1001-待机,1002-故障,1003-停机,1004-休眠,1005-离线,1011-异常
data.dataList[].isSharedBoolean是否来自分享true是false不是
data.dataList[].stationIdString所属场站id1742449261636855336
data.dataList[].systemIdString所属系统id1789836820771635200
data.dataList[].attributeValuesList<Object>设备属性-
data.dataList[].attributeValues.attributeCodeString设备属性SIMCardSuffix
data.dataList[].attributeValues.attributeNameString设备属性名称物联卡号后缀
data.dataList[].attributeValues.attributeValueString设备属性值123456

其他说明

调用示例

请求数据示例

json
{
  "assetScope":0,
  "isGetFirmwareVersion": 0,
  "deviceTypes": ["Inverter"]
}

返回数据示例

样例1：返回租户名下所有设备数据成功

json
{
  "code": "00000",
  "description": "成功",
  "data": [
    {
      "id": "1462654953121251328", //设备信息
      "name": "测试逆变器1",
      "templateCode": "Inverter",
      "sn": "smhtestinveter",
      "tenantId": "1450742399304253441",
      "state": "1000",
      "stateName": "运行",
      "isShared": false,
      "stationId": "1742449261636855336",
      "systemId": "1789836820771635200",
      "attributeValues": [
        {
          //设备固件信息
          "attributeName": "类型",
          "attributeCode": "Type",
          "attributeValue": "CentralizedInverter"
        },
        {
          "attributeName": "SIM卡号",
          "attributeCode": "SIMCardNumber",
          "attributeValue": "89860481122180046902"
        },
        {
          "attributeName": "物联卡号后缀",
          "attributeCode": "SIMCardSuffix",
          "attributeValue": "1440817956502"
        },
        {
          "attributeName": "流量",
          "attributeCode": "Flow",
          "attributeValue": "100MB"
        }
      ]
    },
    {
      "id": "1450743267489611776",
      "name": "环测仪-1",
      "templateCode": "EnvironmentalTester",
      "tenantId": "1450742399304253441",
      "sn": "8100KHTU208G0010",
      "isShared": true,
      "state": "1000",
      "stateName": "运行",
      "stationId": "1742449261636855336",
      "systemId": "1789836820771635200",
      "attributeValues": [
        {
          "attributeName": "类型",
          "attributeCode": "Type",
          "attributeValue": "CentralizedInverter"
        },
        {
          "attributeName": "逆变器额定功率",
          "attributeCode": "RatedPower",
          "attributeValue": "8000"
        },
        {
          "attributeName": "出厂日期",
          "attributeCode": "PackagDate",
          "attributeValue": "2021-10-20T08:39:07.499Z"
        },
        {
          "attributeName": "投运日期",
          "attributeCode": "RuningDate",
          "attributeValue": "2021-10-20T08:39:08.464Z"
        },
        {
          "attributeName": "机型",
          "attributeCode": "Group",
          "attributeValue": "Storage"
        },
        {
          "attributeName": "支架型号",
          "attributeCode": "BracketModel",
          "attributeValue": "22"
        },
        {
          "attributeName": "SIM卡号",
          "attributeCode": "SIMCardNumber",
          "attributeValue": "89860481122180046910"
        },
        {
          "attributeName": "物联卡号后缀",
          "attributeCode": "SIMCardSuffix",
          "attributeValue": "1440817956510"
        },
        {
          "attributeName": "流量",
          "attributeCode": "Flow",
          "attributeValue": "100MB"
        }
      ]
    }
  ]
}
login