查询已上报的能源消耗记录

路径 /industry/datawarehouse/energy/query
版本号 1.0.0
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权
超时时间 5000

请求参数

名称 类型 是否必选 示例值 描述
idList List "idList":[12] 待查询条目的id列表
pageId Int {"pageId":1} 按页获取,指定目标页码,起始值为1
pageSize Int {"pageSize":1500} 指定每页行数
appId String 应用id,saas的共享应用需要传这个值
employeeId String 用户id,需要做用户级别鉴权时需要传入此参数

返回数据

名称 类型 示例值 描述
code Int

响应码, 200: 成功

message String

错误消息

localizedMsg String

本地语言错误消息

data JSON

响应结果

energy JSON

能源上报记录列表

id Long

条目id

statTime String

统计时间

factoryCode String

工厂编码

energyCode String

能源介质代码

energyName String

能源名称

consumption Double

能源耗用量

amount Double

能源好用金额

gmtCreate String

创建时间

gmtModified String

修改时间

page JSON

查询结果的分页信息

pageId Int

查询结果所在的页号

pageSize Int

查询结果的页大小

total Long

总的数据量

示例

请求示例

// https://github.com/aliyun/iotx-api-gateway-client
IoTApiClientBuilderParams ioTApiClientBuilderParams = new IoTApiClientBuilderParams();

ioTApiClientBuilderParams.setAppKey("你的<AppKey>");
ioTApiClientBuilderParams.setAppSecret("你的<AppSecret>");

SyncApiClient syncApiClient = new SyncApiClient(ioTApiClientBuilderParams);

IoTApiRequest request = new IoTApiRequest();

// 设置请求ID
String uuid = UUID.randomUUID().toString();
String id = uuid.replace("-", "");
request.setId(id);
// 设置API版本号
request.setApiVer("1.0.0");

// 设置参数
request.putParam("idList", "value0");
request.putParam("pageId", value1");
request.putParam("pageSize", value2");
request.putParam("appId", value3");
request.putParam("employeeId", value4");
// 如果需要,设置headers
Map<String, String> headers = new HashMap<String, String>(8);
// headers.put("你的<header", "你的<value>");

// 设置请求参数域名, path, request, isHttps, headers
ApiResponse response = syncApiClient.postBody("api.link.aliyun.com", "/industry/datawarehouse/energy/query", request, true, headers);

System.out.println(
    "response code = " + response.getCode()
        + " response = " + new String(response.getBody(), "UTF-8")
        + " headers = " + response.getHeaders().toString()
);

正常返回示例

JSON 格式

{
  "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
  "code": 200,
  "message": null,
  "localizedMsg": null,
  "data": {
    "energy": [
      {
        "factoryCode": "smart_fty",
        "amount": 123.33,
        "gmtModified": 1574939903000,
        "creatorType": "tenant_id",
        "creatorId": "4443ADAF729C42728D7DA9E6DC90E9A8",
        "consumption": 123455,
        "statTime": "2019-10-27",
        "gmtCreate": 1574843773000,
        "id": 1,
        "energyName": "水",
        "energyCode": "energyCode-water"
      }
    ],
    "page": {
      "total": 1,
      "pageSize": 1500,
      "pageId": 1
    }
    
  }
}

异常返回示例

JSON 格式

{
    "id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
    "code": 403,
    "message": "request forbidden.",
    "localizedMsg": "请求被禁止",
    "data": null
}

错误码

HttpCode 错误码 错误信息 描述
500 500 Internal Error Internal Error
503 503 Service Unavailable Service Unavailable
403 403 Request Limited Request Limited
401 401 Empty Signature Empty Signature
400 400 Request Format Error Request Format Error
200 20003 Find Backend Error Find Backend Error
200 20004 Backend Service Error Backend Service Error
200 20055 Backend Service Invalid Request Format Error
200 20056 Hsf Invoke Timeout Hsf Invoke Timeout
200 401 Request Authorized Error Request Authorized Error
200 403 Request Forbidden Request Forbidden
200 500 Server Error Server Error
200 28800 The maximum number of resource that you can create is exceeded. 已达创建资源的上限。
200 28804 Duplicate name. 该名称已经存在,请重新命名。
200 460 request parameter error. 参数错误。
200 28805 Invalid name. 仅支持大小写英文字母、汉字、数字和空格。
200 28805 Invalid name. 仅支持字母、数字和汉字
200 403 request forbidden. 请求被禁止
200 460 request parameter error. 请求参数错误
200 500 server error. 系统错误
200 460 request parameter error. 请求参数错误
200 500 server error. 系统错误
200 403 request forbidden. 请求被禁止
200 403 request forbidden. 请求被禁止
200 460 request parameter error. 请求参数错误
200 500 server error. 系统错误
200 403 request forbidden. 请求被禁止
200 500 server error. 系统错误
200 460 request parameter error. 请求参数错误
200 500 server error. 系统错误
200 460 request parameter error. 请求参数错误
200 403 request forbidden. 请求被禁止
200 403 request forbidden. 请求被禁止
200 460 request parameter error. 请求参数错误
200 500 server error. 系统错误
200 403 request forbidden. 请求被禁止
200 460 request parameter error. 请求参数错误
200 500 server error. 系统错误
200 500 server error. 系统错误
200 403 request forbidden. 请求被禁止
200 460 request parameter error. 请求参数错误
200 500 server error. 系统错误
200 403 request forbidden. 请求被禁止
200 460 request parameter error. 请求参数错误
200 500 server error. 系统错误
200 403 request forbidden. 请求被禁止
200 460 request parameter error. 请求参数错误
200 403 request forbidden. 请求被禁止
200 460 request parameter error. 请求参数错误
200 500 server error. 系统错误
200 1009 SQL invoke error SQL 执行出错