更新时间:2021-12-27 GMT+08:00
分享

注册终端设备

功能介绍

该API用于注册一个终端设备。

调试

您可以在API Explorer中调试该接口。

URI

POST /v2/{project_id}/edgemgr/devices

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

ief-instance-id

String

铂金版实例ID,专业版实例为空值

表3 请求Body参数

参数

是否必选

参数类型

描述

device

EdgemgrDevicesDetail object

终端设备属性

表4 EdgemgrDevicesDetail

参数

是否必选

参数类型

描述

id

String

终端设备ID,只允许英文字母、数字、下划线、中划线,必须以英文字母和数字开头,长度限制为24~64之间

name

String

终端设备名称,只允许中文字符、英文字母、数字、下划线、中划线,长度限制为1~64

description

String

终端设备描述,最大长度255,不允许^ ~ # $ % & * < > ( ) [ ] { } ' " \

attributes

Map<String,ValueInAttributes>

静态属性

connection_type

String

连接类型,默认为edge

access_protocol

String

访问协议,有如下选项:

  • userdefine:自定义协议

  • modbus:modbus协议

  • opc-ua:opc-ua协议 默认为userdefine

twin

Map<String,ValueInTwin>

终端设备动态属性

access_config

AccessConfig object

访问配置,与access_protocol直接关联

property_visitors

Map<String,ValueInPropertyVisitors>

孪生属性配置

表5 ValueInAttributes

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表6 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表7 ValueInTwin

参数

是否必选

参数类型

描述

excepted

excepted object

动态属性的期望信息

optional

Boolean

动态属性的期望信息

metadata

Metadata object

期望值设置的时间信息

表8 excepted

参数

是否必选

参数类型

描述

value

String

动态属性的初始值,最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、冒号、/、@、#

metadata

metadata object

期望值设置的时间信息

表9 metadata

参数

是否必选

参数类型

描述

timestamp

String

修改时间,UNIX timestamp格式

表10 Metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表11 AccessConfig

参数

是否必选

参数类型

描述

protocol_type

protocol_type object

设备访问类型,包含:

  • userdefine:自定义访问协议;

  • TCP:modbus访问协议中的一种访问形式;

  • RTU:modbus访问协议中的一种访问形式;

  • opc-ua:opc-ua访问协议;

protocol_name

protocol_name object

设备访问名称

slave_id

slave_id object

Modbus设备访问id(0-255)

ip

ip object

TCP传输模式下访问ip地址(标准ipv4地址)

port

port object

TCP传输模式下访问端口(0-65535)

serial_port

serial_port object

RTU传输模式下串口配置

baud_rate

baud_rate object

RTU传输模式下波特率配置,value值字段可选50、75、110、150、200、300、1200、1800、2400、9600、19200、38400、57600、115200

data_bits

data_bits object

RTU传输模式下数据位配置,value值字段包括5、6、7、8

stop_bits

stop_bits object

RTU传输模式下停止位配置,value值字段包含1、2

parity_bits

parity_bits object

RTU传输模式下校验位配置,value值字段可选为none、odd、even

url

url object

OPC-UA协议下访问url地址

sec_mode

sec_mode object

OPC-UA协议下访问安全模式

sec_policy

sec_policy object

OPC-UA协议下访问安全策略

auth_type

auth_type object

OPC-UA协议下访问认证类型,value值字段可选为0、1、2、3

username

username object

OPC-UA协议下,采用密码认证时用户名字段

password

password object

OPC-UA协议下,采用密码认证时密码字段

private_key

private_key object

OPC-UA协议下,采用证书认证时私钥字段,value字段为base64格式

certificate

certificate object

OPC-UA协议下,采用证书认证时证书字段,value字段为base64格式

timeout

timeout object

OPC-UA协议下访问超时配置,默认为5s

表12 protocol_type

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表13 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表14 protocol_name

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表15 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表16 slave_id

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表17 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表18 ip

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表19 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表20 port

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表21 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表22 serial_port

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表23 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表24 baud_rate

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表25 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表26 data_bits

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表27 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表28 stop_bits

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表29 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表30 parity_bits

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表31 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表32 url

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表33 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表34 sec_mode

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表35 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表36 sec_policy

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表37 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表38 auth_type

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表39 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表40 username

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表41 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表42 password

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表43 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表44 private_key

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表45 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表46 certificate

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表47 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表48 timeout

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表49 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表50 ValueInPropertyVisitors

参数

是否必选

参数类型

描述

register_type

register_type object

寄存器类型,value值字段可选为CoilsRegisters、HoldingRegisters、DiscreteInputsRegisters、InputRegisters

access_mode

access_mode object

访问模式,value值字段可选为r和r/w

register_index

register_index object

寄存器偏移地址,value值字段取值范围0-65535

register_num

register_num object

寄存器个数

scale_index

scale_index object

缩放因子

original_datatype

original_datatype object

原始数据类型

expected_datatype

expected_datatype object

期望数据类型

is_registerswap

is_registerswap object

是否交换寄存器顺序

is_swap

is_swap object

是否交换高低字节

sample_interval

sample_interval object

数据采集间隔,取值范围为1-3600

data_min

data_min object

原始数据值区间最小值,与原始数据类型关联

data_max

data_max object

原始数据值区间最大值,与原始数据类型关联

node_id

node_id object

节点id

browse_name

browse_name object

节点名称

表51 register_type

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表52 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表53 access_mode

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表54 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表55 register_index

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表56 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表57 register_num

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表58 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表59 scale_index

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表60 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表61 original_datatype

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表62 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表63 expected_datatype

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表64 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表65 is_registerswap

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表66 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表67 is_swap

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表68 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表69 sample_interval

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表70 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表71 data_min

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表72 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表73 data_max

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表74 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表75 node_id

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表76 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表77 browse_name

参数

是否必选

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表78 metadata

参数

是否必选

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

响应参数

状态码: 201

表79 响应Body参数

参数

参数类型

描述

device

Device object

终端设备属性

表80 Device

参数

参数类型

描述

id

String

终端设备ID,只允许英文字母、数字、下划线、中划线,必须以英文字母和数字开头,长度限制为24~64之间

name

String

终端设备名称,只允许中文字符、英文字母、数字、下划线、中划线,长度限制为1~64

access_protocol

String

访问协议,有如下选项:

  • userdefine:自定义协议

  • modbus:modbus协议

  • opc-ua:opc-ua协议 默认为userdefine

description

String

终端设备描述,最大长度255,不允许^ ~ # $ % & * < > ( ) [ ] { } ' " \

project_id

String

项目ID

created_at

String

创建时间

updated_at

String

更新时间

attributes

Map<String,ValueInAttributes>

静态属性

connection_type

String

连接类型,默认为edge

twin

Map<String,ValueInTwinResponse>

终端设备静态属性信息

access_config

AccessConfig object

访问配置,与access_protocol直接关联

property_visitors

Map<String,ValueInPropertyVisitors>

孪生属性配置

表81 ValueInAttributes

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表82 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表83 ValueInTwinResponse

参数

参数类型

描述

excepted

excepted object

动态属性的期望信息

actual

actual object

动态属性的实际信息

metadata

metadata object

动态属性的元数据信息

optional

Boolean

标识属性是否可选,默认为true,继承模板的属性默认为false

表84 excepted

参数

参数类型

描述

value

String

动态属性的初始值,最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、冒号、/、@、#

表85 actual

参数

参数类型

描述

value

String

动态属性的初始值,最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、冒号、/、@、#

表86 metadata

参数

参数类型

描述

timestamp

String

修改时间,UNIX timestamp格式

表87 AccessConfig

参数

参数类型

描述

protocol_type

protocol_type object

设备访问类型,包含:

  • userdefine:自定义访问协议;

  • TCP:modbus访问协议中的一种访问形式;

  • RTU:modbus访问协议中的一种访问形式;

  • opc-ua:opc-ua访问协议;

protocol_name

protocol_name object

设备访问名称

slave_id

slave_id object

Modbus设备访问id(0-255)

ip

ip object

TCP传输模式下访问ip地址(标准ipv4地址)

port

port object

TCP传输模式下访问端口(0-65535)

serial_port

serial_port object

RTU传输模式下串口配置

baud_rate

baud_rate object

RTU传输模式下波特率配置,value值字段可选50、75、110、150、200、300、1200、1800、2400、9600、19200、38400、57600、115200

data_bits

data_bits object

RTU传输模式下数据位配置,value值字段包括5、6、7、8

stop_bits

stop_bits object

RTU传输模式下停止位配置,value值字段包含1、2

parity_bits

parity_bits object

RTU传输模式下校验位配置,value值字段可选为none、odd、even

url

url object

OPC-UA协议下访问url地址

sec_mode

sec_mode object

OPC-UA协议下访问安全模式

sec_policy

sec_policy object

OPC-UA协议下访问安全策略

auth_type

auth_type object

OPC-UA协议下访问认证类型,value值字段可选为0、1、2、3

username

username object

OPC-UA协议下,采用密码认证时用户名字段

password

password object

OPC-UA协议下,采用密码认证时密码字段

private_key

private_key object

OPC-UA协议下,采用证书认证时私钥字段,value字段为base64格式

certificate

certificate object

OPC-UA协议下,采用证书认证时证书字段,value字段为base64格式

timeout

timeout object

OPC-UA协议下访问超时配置,默认为5s

表88 protocol_type

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表89 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表90 protocol_name

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表91 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表92 slave_id

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表93 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表94 ip

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表95 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表96 port

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表97 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表98 serial_port

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表99 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表100 baud_rate

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表101 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表102 data_bits

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表103 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表104 stop_bits

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表105 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表106 parity_bits

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表107 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表108 url

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表109 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表110 sec_mode

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表111 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表112 sec_policy

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表113 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表114 auth_type

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表115 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表116 username

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表117 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表118 password

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表119 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表120 private_key

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表121 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表122 certificate

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表123 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表124 timeout

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表125 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表126 ValueInPropertyVisitors

参数

参数类型

描述

register_type

register_type object

寄存器类型,value值字段可选为CoilsRegisters、HoldingRegisters、DiscreteInputsRegisters、InputRegisters

access_mode

access_mode object

访问模式,value值字段可选为r和r/w

register_index

register_index object

寄存器偏移地址,value值字段取值范围0-65535

register_num

register_num object

寄存器个数

scale_index

scale_index object

缩放因子

original_datatype

original_datatype object

原始数据类型

expected_datatype

expected_datatype object

期望数据类型

is_registerswap

is_registerswap object

是否交换寄存器顺序

is_swap

is_swap object

是否交换高低字节

sample_interval

sample_interval object

数据采集间隔,取值范围为1-3600

data_min

data_min object

原始数据值区间最小值,与原始数据类型关联

data_max

data_max object

原始数据值区间最大值,与原始数据类型关联

node_id

node_id object

节点id

browse_name

browse_name object

节点名称

表127 register_type

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表128 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表129 access_mode

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表130 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表131 register_index

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表132 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表133 register_num

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表134 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表135 scale_index

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表136 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表137 original_datatype

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表138 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表139 expected_datatype

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表140 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表141 is_registerswap

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表142 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表143 is_swap

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表144 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表145 sample_interval

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表146 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表147 data_min

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表148 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表149 data_max

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表150 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表151 node_id

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表152 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

表153 browse_name

参数

参数类型

描述

value

String

value 最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~

optional

Boolean

标识属性是否可选,默认为true

metadata

metadata object

静态属性的元数据信息,默认为{"type": "string"}

表154 metadata

参数

参数类型

描述

type

String

属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string

请求示例

{
  "device" : {
    "access_protocol" : "userdefine",
    "name" : "device",
    "connection_type" : "edge",
    "description" : "",
    "attributes" : { }
  }
}

响应示例

状态码: 201

ok

{
  "device" : {
    "id" : "1398f13d-f24d-4de4-8cd3-5905db1d6d9f",
    "name" : "device",
    "access_protocol" : "",
    "project_id" : "05e1aef9040010e22fccc009adecb056",
    "description" : "",
    "created_at" : "2020-09-23T02:00:22.858736Z",
    "updated_at" : "",
    "access_config" : { },
    "connection_type" : "edge"
  }
}

状态码

状态码

描述

201

ok

错误码

请参见错误码

分享:

    相关文档

    相关产品

关闭导读