更新时间:2024-06-20 GMT+08:00
分享

创建点位表配置

功能介绍

用户通过Console接口在指定边缘节点上点位表配置

调试

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

URI

POST /v2/{project_id}/edge-nodes/{edge_node_id}/ots/data-sources/{ds_id}/points

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取方法请参见 获取项目ID

edge_node_id

String

边缘节点ID

最小长度:1

最大长度:64

ds_id

String

采集数据源id,创建数据源配置时设置,节点下唯一。

最小长度:1

最大长度:64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证

表3 请求Body参数

参数

是否必选

参数类型

描述

point_id

String

点位表id,数据源下唯一

最小长度:1

最大长度:64

name

String

点位名称,允许中、数字、英文大小写、下划线、中划线、#%()*特殊字符

最小长度:1

最大长度:64

data_type

String

点位数据类型

最小长度:1

最大长度:32

collection_config

Object

点位采集配置

device_id

String

设备id

property

String

属性,允许中、数字、英文大小写、下划线、中划线

最小长度:0

最大长度:128

processing_config

ProcessingConfigDTO object

点位处理配置

表4 ProcessingConfigDTO

参数

是否必选

参数类型

描述

validity

PointValidityingDTO object

点位校验

stream_formula

String

点位流公式配置字段

最小长度:0

最大长度:128

scaling

PointScalingDTO object

点位缩放规则列表

clean

PointCleanDTO object

点位计算规则列表

表5 PointValidityingDTO

参数

是否必选

参数类型

描述

min

Object

点位上报值的最小值,小于该值则上报告警

max

Object

点位上报值的最大值,大于该值则上报告警

outlier_filtering

Boolean

异常值过滤

表6 PointScalingDTO

参数

是否必选

参数类型

描述

ratio

Double

缩放的倍率

最小值:-10000

最大值:10000

base

Double

基准值

最小值:-10000

最大值:10000

accuracy

Integer

缩放后结果的精度,精确到小数点后几位,-1表示全部保留,0表示只保留整数位

最小值:-1

最大值:8

缺省值:-1

表7 PointCleanDTO

参数

是否必选

参数类型

描述

silent_window

Integer

静默时间窗口,在该时间窗口内,没有触发上报条件,点位将不会上

最小值:0

最大值:86400

deviation

Double

偏差,在该偏差范围内表示是正常波动,点位将不进行上报

最小值:0

最大值:100

响应参数

状态码: 201

表8 响应Body参数

参数

参数类型

描述

point_id

String

点位表id,数据源下唯一

最小长度:1

最大长度:64

name

String

点位名称,允许中、数字、英文大小写、下划线、中划线、#%()*特殊字符

最小长度:1

最大长度:64

collection_config

Object

点位采集配置

device_id

String

设备id

property

String

属性,允许中、数字、英文大小写、下划线、中划线

最小长度:1

最大长度:128

data_type

String

点位数据类型

最小长度:1

最大长度:32

ds_id

String

采集数据源id,节点下唯一

最小长度:1

最大长度:64

processing_config

ProcessingConfigDTO object

点位处理配置

create_time

String

创建时间

最小长度:0

最大长度:256

update_time

String

最后一次修改时间

最小长度:0

最大长度:256

表9 ProcessingConfigDTO

参数

参数类型

描述

validity

PointValidityingDTO object

点位校验

stream_formula

String

点位流公式配置字段

最小长度:0

最大长度:128

scaling

PointScalingDTO object

点位缩放规则列表

clean

PointCleanDTO object

点位计算规则列表

表10 PointValidityingDTO

参数

参数类型

描述

min

Object

点位上报值的最小值,小于该值则上报告警

max

Object

点位上报值的最大值,大于该值则上报告警

outlier_filtering

Boolean

异常值过滤

表11 PointScalingDTO

参数

参数类型

描述

ratio

Double

缩放的倍率

最小值:-10000

最大值:10000

base

Double

基准值

最小值:-10000

最大值:10000

accuracy

Integer

缩放后结果的精度,精确到小数点后几位,-1表示全部保留,0表示只保留整数位

最小值:-1

最大值:8

缺省值:-1

表12 PointCleanDTO

参数

参数类型

描述

silent_window

Integer

静默时间窗口,在该时间窗口内,没有触发上报条件,点位将不会上

最小值:0

最大值:86400

deviation

Double

偏差,在该偏差范围内表示是正常波动,点位将不进行上报

最小值:0

最大值:100

请求示例

GET https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id}/ots/data-sources/{ds_id}/points

{
  "point_id" : "MotorVoltage",
  "name" : "马达电压",
  "data_type" : "int",
  "collection_config" : {
    "address" : "ns=2;s=Root/Motor/Voltage",
    "data_type" : "int",
    "cycle" : 10000
  },
  "device_id" : "MotorVoltage",
  "property" : "Motor/Voltage",
  "processing_config" : {
    "validity" : {
      "min" : 60,
      "max" : 100
    },
    "stream_formula" : "bit(0).bool()|string_to_double(-1.0)|string_to_int(0)",
    "scaling" : {
      "ratio" : 1,
      "base" : 100,
      "accuracy" : 2
    },
    "clean" : {
      "silent_window" : 60,
      "deviation" : 0.1
    }
  }
}

响应示例

状态码: 201

Created

{
  "point_id" : "MotorVoltage",
  "name" : "马达电压",
  "collection_config" : {
    "address" : "ns=2;s=Root/Motor/Voltage",
    "data_type" : "int",
    "cycle" : 10000
  },
  "device_id" : "MotorVoltage",
  "property" : "Motor/Voltage",
  "data_type" : "int",
  "ds_id" : "opcua_1",
  "processing_config" : {
    "validity" : {
      "min" : 60,
      "max" : 100
    },
    "stream_formula" : "bit(0).bool()|string_to_double(-1.0)|string_to_int(0)",
    "scaling" : {
      "ratio" : 1,
      "base" : 100,
      "accuracy" : 2
    },
    "clean" : {
      "silent_window" : 60,
      "deviation" : 0.1
    }
  },
  "create_time" : "2020-05-28T11:31:29.740Z",
  "update_time" : "2020-05-28T11:31:29.740Z"
}

状态码

状态码

描述

201

Created

400

Bad Request

404

Not Found

错误码

请参见错误码

相关文档