更新时间:2022-07-13 GMT+08:00
分享

获取资产属性历史值

功能介绍

获取资产属性历史值

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v1/{project_id}/assets/{asset_id}/property-values/query

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

最大长度:128

asset_id

String

资产ID

最大长度:256

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

租户Token

最大长度:65535

表3 请求Body参数

参数

是否必选

参数类型

描述

time_span

TimeSpanDT object

起止时间

tags

map<string, object>

对property按指定tags标签进行过滤查询,填入资产标签属性的属性名与属性值,不可为空,例如 {"tagPropertyA": "id0001"};注意,标签过滤只对打上标签时刻之后的数据生效,打标签之前的数据不能通过标签过滤

property_filter

Array of PropertyFilter objects

属性过滤器,最多5个

property_names

Array of strings

待查询的资产属性列表

limit

Integer

返回值个数限制

最大值:2000

缺省值:2000

表4 TimeSpanDT

参数

是否必选

参数类型

描述

from

String

起始时间, 使用UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss.SSS'Z',示例:2021-02-01T00:00:00.123Z

最大长度:64

to

String

结束时间,使用UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss.SSS'Z',示例:2021-02-01T00:00:00.123Z

最大长度:64

表5 PropertyFilter

参数

是否必选

参数类型

描述

property_name

String

过滤属性名称,正则:"^[a-zA-Z0-9_]{1,64}$"

最小长度:1

最大长度:64

operator

String

过滤操作方式,当前仅支持“=”

最小长度:1

最大长度:64

value

Object

过滤属性值

响应参数

状态码: 200

表6 响应Body参数

参数

参数类型

描述

timestamps

Array of strings

时间序列,使用UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss.SSS'Z',示例:2021-02-01T00:00:00.123Z

properties

Array of RawValue objects

响应属性列表

表7 RawValue

参数

参数类型

描述

property_name

String

属性名称

values

Array of objects

资产属性的历史值序列,示例:[1,2]

请求示例

{
  "time_span" : {
    "from" : "2021-02-01T00:00:00.123Z",
    "to" : "2021-02-05T20:00:00.100Z"
  },
  "tags" : {
    "tagPropertyA" : "IA2006300"
  },
  "property_filter" : [ {
    "property_name" : "string",
    "operator" : "=",
    "value" : 1
  } ],
  "property_names" : [ "string" ],
  "limit" : 2000
}

响应示例

状态码: 200

OK

{
  "timestamps" : [ "string" ],
  "properties" : [ {
    "property_name" : "string",
    "values" : [ { } ]
  } ]
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

错误码

请参见错误码

相关文档