实时服务接口

版本记录

版本号	日期	修改内容
v0.14.2	2024-08-30	修复已知问题

实时服务

单测点读值

接口功能

读取实时库单个测点的当前值。

接口类型

HTTP 接口

接口地址

URL	{Server}/v1/rtdata/node/{nodeId}
http 请求方式	get

请求参数

1. 请求参数说明

序号	名称	类型	是否必填	描述
1	nodeId	String	是	测点名列表，格式为“命名空间:测点名”，如“100:AI001.PV”

1. 请求示例

get {Server}/v1/rtdata/node/100:AI001.PV

执行结果

1. 返回值参数说明

名称	类型	描述
code	int	返回码，0 成功，其他失败
message	String	返回信息描述
results	ReadDataValue	返回的结果

ReadDataValue结构定义如下：

名称	类型	说明
nodeId	String	测点名
st	long	原始测点值变化时间，Unix 时间戳，精确到毫秒
t	long	实时服务返回的时间，Unix 时间戳，精确到毫秒
q	int	测点值质量位
v	Json 基本数据类型	值

1. 示例说明

{
“code” : 0,
“message” : “success”,
“results” : {
       “nodeId”: “100:AI001.PV”,
	    “st” : 1627281919157,
        “t” : 1627281919157,
“q” : 1,
“v”:11.1,
}
}

多测点多项读值

接口功能

读取实时库测点的当前值，支持批量读取。

接口类型

HTTP 接口

接口地址

URL	{Server}/v1/rtdata/node/read
http 请求方式	post

请求参数

1. 请求参数说明

序号	名称	类型	是否必填	描述
1	nodeId	String[]	是	测点名列表，格式为“命名空间:测点名”，如“100:AI001.AV”，单次最大读取点数为 1000。

1. 请求示例

{
    “nodeIds”: [“100:AI001.PV”, “100:EQ001.DI001.PV”]
}

执行结果

1. 返回值参数说明

名称	类型	描述
code	int	返回码，0 成功，其他失败
message	String	返回信息描述
results	ReadDataValue[]	返回的结果列表

1. 示例说明

{
“code” : 0,
“message” : “success”,
“results” : [{
       “nodeId”: “100:AI001.PV”,
	    “st” : 1627281919157,
        “t” : 1627281919157,
“q” : 1,
“v”:11.1,
},
{
    “nodeId”: “100:EQ001.DI001.PV”,
“st” : 1627281919157,
        “t” : 1627281919157,
“q” : 1,
“v”:true,
}]
}

多测点多点项写值

接口功能

向实时库测点写值，支持批量写入。

接口类型

HTTP 接口

接口地址

URL	{Server}/v1/rtdata/node/write
http 请求方式	post

请求参数

1. 请求参数说明

序号	名称	类型	是否必填	描述
1	data	String[]	是	写值对象列表

WriteDataValue定义如下：

属性名称	类型	说明
nodeId	String	测点名，格式为“命名空间:测点名”，如“100:AI001.PV”
value	Json 基本数据类型	值

1. 请求示例

“data” : [
 {
“nodeId”: “100:AI001.PV”,
“value”:12.1
},
{
“nodeId”: “100:EQ001.DI001.PV”,
“value”:false
}
]

执行结果

1. 返回值参数说明

名称	类型	描述
code	int	返回码，0 成功，其他失败
message	String	返回信息描述
results	int []	每个测点写入结果状态码列表，0 表示成功，其他失败

1. 示例说明

{
“code” : 0,
“message” : “success”,
“results” : [0,0]
}

点强制

接口功能

对测点进行强制。

接口类型

HTTP 接口

接口地址

URL	{Server}/v1/rtdata/node/force
http 请求方式	post

请求参数

1. 请求参数说明

序号	名称	类型	是否必填	描述
1	data	WriteDataValue []	是	强制对象列表，WriteDataValue定义如上

1. 请求示例

“data” : [
 {
“nodeId”: “100:AI001.PV”,
“value”:12.1
},
{
“nodeId”: “100:EQ001.DI001.PV”,
“value”:false
}
]

执行结果

1. 返回值参数说明

名称	类型	描述
code	int	返回码，0 成功，其他失败
message	String	返回信息描述
results	int []	每个测点强制结果状态码列表，0 表示成功，其他失败

1. 示例说明

{
“code” : 0,
“message” : “success”,
“results” : [0,0]
}

取消强制

接口功能

对测点取消强制。

接口类型

HTTP 接口

接口地址

URL	{Server}/v1/rtdata/node/unforce
http 请求方式	post

请求参数

1. 请求参数说明

序号	名称	类型	是否必填	描述
1	nodeIds	String[]	是	测点名列表，格式为“命名空间:测点名”，如“100:AI001.AV”，单次最大点数为 1000。

1. 请求示例

{
    “nodeIds”: [“100:AI001.PV”, “100:EQ001.DI001.PV”]
}

执行结果

1. 返回值参数说明

名称	类型	描述
code	int	返回码，0 成功，其他失败
message	String	返回信息描述
results	int []	每个测点取消强制结果状态码列表，0 表示成功，其他失败

1. 示例说明

{
“code” : 0,
“message” : “success”,
“results” : [0,0]
}

点禁止

接口功能

对测点进行禁止操作。

接口类型

HTTP 接口

接口地址

URL	{Server}/v1/rtdata/node/disable
http 请求方式	post

请求参数

1. 请求参数说明

序号	名称	类型	是否必填	描述
1	nodeIds	String[]	是	测点名列表，格式为“命名空间:测点名”，如“100:AI001.AV”，单次最大点数为 1000。

1. 请求示例

{
    “nodeIds”: [“100:AI001.PV”, “100:EQ001.DI001.PV”]
}

执行结果

1. 返回值参数说明

名称	类型	描述
code	int	返回码，0 成功，其他失败
message	String	返回信息描述
results	int []	每个测点禁止结果状态码列表，0 表示成功，其他失败

1. 示例说明

{
“code” : 0,
“message” : “success”,
“results” : [0,0]
}

取消禁止

接口功能

对测点取消禁止。

接口类型

HTTP 接口

接口地址

URL	{Server}/v1/rtdata/node/undisable
http 请求方式	post

请求参数

1. 请求参数说明

序号	名称	类型	是否必填	描述
1	nodeIds	String[]	是	测点名列表，格式为“命名空间:测点名”，如“100:AI001.AV”，单次最大点数为 1000。

1. 请求示例

{
    “nodeIds”: [“100:AI001.PV”, “100:EQ001.DI001.PV”]
}

执行结果

1. 返回值参数说明

名称	类型	描述
code	int	返回码，0 成功，其他失败
message	String	返回信息描述
results	int []	每个测点取消禁止结果状态码列表，0 表示成功，其他失败

1. 示例说明

{
“code” : 0,
“message” : “success”,
“results” : [0,0]
}