请求参数
4.2 终端设备管理
4.2.1 注册终端设备
功能介绍
该API用于注册一个终端设备。
调试
您可以在API Explorer中调试该接口。
URI
POST /v2/{project_id}/edgemgr/devices
表4-92 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID
请求参数
表4-93 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。
通过调用IAM服务获取用户 Token接口获取（响应消息头中 X-Subject-Token的值）。
ief-instance-id 否 String 铂金版实例ID，专业版实例为空 值
表4-94 请求 Body 参数
参数 是否必选 参数类型 描述
device 是 EdgemgrDevi
cesDetail object
终端设备属性
表4-95 EdgemgrDevicesDetail
参数 是否必选 参数类型 描述
id 否 String 终端设备ID，只允许英文字母、
数字、下划线、中划线，必须以 英文字母和数字开头，长度限制 为24~64之间
name 是 String 终端设备名称，只允许中文字
符、英文字母、数字、下划线、
中划线，长度限制为1~64 description 否 String 终端设备描述，最大长度255，
不允许^ ~ # $ % & * < > ( ) [ ] { } ' " \
attributes 否 Map<String,V alueInAttribu tes>
静态属性
connection_ty
pe 否 String 连接类型，默认为edge
参数 是否必选 参数类型 描述 access_protoc
ol 否 String 访问协议，有如下选项：
● userdefine：自定义协议
● modbus：modbus协议
● opc-ua：opc-ua协议 默认为 userdefine
twin 否 Map<String,V
alueInTwin> 终端设备动态属性 access_config 否 AccessConfig
object 访问配置，与access_protocol直 接关联
property_visit
ors 否 Map<String,V alueInProper tyVisitors>
孪生属性配置
表4-96 ValueInAttributes
参数 是否必选 参数类型 描述
value 是 String value 最大长度512， value允 许英文字母、数字、下划线、中 划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional 否 Boolean 标识属性是否可选，默认为true
metadata 否 metadata
object 静态属性的元数据信息，默认为 {"type": "string"}
表4-97 metadata
参数 是否必选 参数类型 描述
type 是 String 属性类型标识，string|int|float|
boolean（boolean类型为true 或false），默认为string
表4-98 ValueInTwin
参数 是否必选 参数类型 描述
excepted 是 excepted
object 动态属性的期望信息
optional 否 Boolean 动态属性的期望信息
参数 是否必选 参数类型 描述 metadata 否 Metadata
object 期望值设置的时间信息
表4-99 excepted
参数 是否必选 参数类型 描述
value 是 String 动态属性的初始值，最大长度
512， value允许英文字母、数 字、下划线、中划线、点、逗 号、冒号、/、@、#
metadata 否 metadata
object 期望值设置的时间信息
表4-100 metadata
参数 是否必选 参数类型 描述
timestamp 否 String 修改时间，UNIX timestamp格 式
表4-101 Metadata
参数 是否必选 参数类型 描述
type 是 String 属性类型标识，string|int|float|
boolean（boolean类型为true 或false），默认为string
表4-102 AccessConfig
参数 是否必选 参数类型 描述
protocol_type 是 protocol_typ
e object 设备访问类型，包含：
● userdefine：自定义访问协 议；
● TCP：modbus访问协议中的 一种访问形式；
● RTU：modbus访问协议中的 一种访问形式；
● opc-ua：opc-ua访问协议；
参数 是否必选 参数类型 描述 protocol_nam
e 否 protocol_na
me 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
表4-103 protocol_type
参数 是否必选 参数类型 描述
value 是 String value 最大长度512， value允 许英文字母、数字、下划线、中 划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional 否 Boolean 标识属性是否可选，默认为true
metadata 否 metadata
object 静态属性的元数据信息，默认为 {"type": "string"}
表4-104 metadata
参数 是否必选 参数类型 描述
type 是 String 属性类型标识，string|int|float|
boolean（boolean类型为true 或false），默认为string
表4-105 protocol_name
参数 是否必选 参数类型 描述
value 是 String value 最大长度512， value允 许英文字母、数字、下划线、中 划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional 否 Boolean 标识属性是否可选，默认为true
metadata 否 metadata
object 静态属性的元数据信息，默认为 {"type": "string"}
表4-106 metadata
参数 是否必选 参数类型 描述
type 是 String 属性类型标识，string|int|float|
boolean（boolean类型为true 或false），默认为string
表4-107 slave_id
参数 是否必选 参数类型 描述
value 是 String value 最大长度512， value允 许英文字母、数字、下划线、中 划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional 否 Boolean 标识属性是否可选，默认为true
metadata 否 metadata
object 静态属性的元数据信息，默认为 {"type": "string"}
表4-108 metadata
参数 是否必选 参数类型 描述
type 是 String 属性类型标识，string|int|float|
boolean（boolean类型为true 或false），默认为string
表4-109 ip
参数 是否必选 参数类型 描述
value 是 String value 最大长度512， value允 许英文字母、数字、下划线、中 划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional 否 Boolean 标识属性是否可选，默认为true
metadata 否 metadata
object 静态属性的元数据信息，默认为 {"type": "string"}
表4-110 metadata
参数 是否必选 参数类型 描述
type 是 String 属性类型标识，string|int|float|
boolean（boolean类型为true 或false），默认为string
表4-111 port
参数 是否必选 参数类型 描述
value 是 String value 最大长度512， value允 许英文字母、数字、下划线、中 划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional 否 Boolean 标识属性是否可选，默认为true
metadata 否 metadata
object 静态属性的元数据信息，默认为 {"type": "string"}
表4-112 metadata
参数 是否必选 参数类型 描述
type 是 String 属性类型标识，string|int|float|
boolean（boolean类型为true 或false），默认为string
表4-113 serial_port
参数 是否必选 参数类型 描述
value 是 String value 最大长度512， value允 许英文字母、数字、下划线、中 划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional 否 Boolean 标识属性是否可选，默认为true
metadata 否 metadata
object 静态属性的元数据信息，默认为 {"type": "string"}
表4-114 metadata
参数 是否必选 参数类型 描述
type 是 String 属性类型标识，string|int|float|
boolean（boolean类型为true 或false），默认为string
表4-115 baud_rate
参数 是否必选 参数类型 描述
value 是 String value 最大长度512， value允 许英文字母、数字、下划线、中 划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional 否 Boolean 标识属性是否可选，默认为true
metadata 否 metadata
object 静态属性的元数据信息，默认为 {"type": "string"}
表4-116 metadata
参数 是否必选 参数类型 描述
type 是 String 属性类型标识，string|int|float|
boolean（boolean类型为true 或false），默认为string
表4-117 data_bits
参数 是否必选 参数类型 描述
value 是 String value 最大长度512， value允 许英文字母、数字、下划线、中 划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional 否 Boolean 标识属性是否可选，默认为true
metadata 否 metadata
object 静态属性的元数据信息，默认为 {"type": "string"}
表4-118 metadata
参数 是否必选 参数类型 描述
type 是 String 属性类型标识，string|int|float|
boolean（boolean类型为true 或false），默认为string
表4-119 stop_bits
参数 是否必选 参数类型 描述
value 是 String value 最大长度512， value允 许英文字母、数字、下划线、中 划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional 否 Boolean 标识属性是否可选，默认为true
metadata 否 metadata
object 静态属性的元数据信息，默认为 {"type": "string"}
表4-120 metadata
参数 是否必选 参数类型 描述
type 是 String 属性类型标识，string|int|float|
boolean（boolean类型为true 或false），默认为string
表4-121 parity_bits
参数 是否必选 参数类型 描述
value 是 String value 最大长度512， value允 许英文字母、数字、下划线、中 划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional 否 Boolean 标识属性是否可选，默认为true
metadata 否 metadata
object 静态属性的元数据信息，默认为 {"type": "string"}
表4-122 metadata
参数 是否必选 参数类型 描述
type 是 String 属性类型标识，string|int|float|
boolean（boolean类型为true 或false），默认为string
表4-123 url
参数 是否必选 参数类型 描述
value 是 String value 最大长度512， value允 许英文字母、数字、下划线、中 划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional 否 Boolean 标识属性是否可选，默认为true
metadata 否 metadata
object 静态属性的元数据信息，默认为 {"type": "string"}
表4-124 metadata
参数 是否必选 参数类型 描述
type 是 String 属性类型标识，string|int|float|
boolean（boolean类型为true 或false），默认为string
表4-125 sec_mode
参数 是否必选 参数类型 描述
value 是 String value 最大长度512， value允 许英文字母、数字、下划线、中 划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional 否 Boolean 标识属性是否可选，默认为true
metadata 否 metadata
object 静态属性的元数据信息，默认为 {"type": "string"}
表4-126 metadata
参数 是否必选 参数类型 描述
type 是 String 属性类型标识，string|int|float|
boolean（boolean类型为true 或false），默认为string
表4-127 sec_policy
参数 是否必选 参数类型 描述
value 是 String value 最大长度512， value允 许英文字母、数字、下划线、中 划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional 否 Boolean 标识属性是否可选，默认为true
metadata 否 metadata
object 静态属性的元数据信息，默认为 {"type": "string"}
表4-128 metadata
参数 是否必选 参数类型 描述
type 是 String 属性类型标识，string|int|float|
boolean（boolean类型为true 或false），默认为string
表4-129 auth_type
参数 是否必选 参数类型 描述
value 是 String value 最大长度512， value允 许英文字母、数字、下划线、中 划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional 否 Boolean 标识属性是否可选，默认为true
metadata 否 metadata
object 静态属性的元数据信息，默认为 {"type": "string"}
表4-130 metadata
参数 是否必选 参数类型 描述
type 是 String 属性类型标识，string|int|float|
boolean（boolean类型为true 或false），默认为string
表4-131 username
参数 是否必选 参数类型 描述
value 是 String value 最大长度512， value允 许英文字母、数字、下划线、中 划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional 否 Boolean 标识属性是否可选，默认为true
metadata 否 metadata
object 静态属性的元数据信息，默认为 {"type": "string"}
表4-132 metadata
参数 是否必选 参数类型 描述
type 是 String 属性类型标识，string|int|float|
boolean（boolean类型为true 或false），默认为string
表4-133 password
参数 是否必选 参数类型 描述
value 是 String value 最大长度512， value允 许英文字母、数字、下划线、中 划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional 否 Boolean 标识属性是否可选，默认为true
metadata 否 metadata
object 静态属性的元数据信息，默认为 {"type": "string"}
表4-134 metadata
参数 是否必选 参数类型 描述
type 是 String 属性类型标识，string|int|float|
boolean（boolean类型为true 或false），默认为string
表4-135 private_key
参数 是否必选 参数类型 描述
value 是 String value 最大长度512， value允 许英文字母、数字、下划线、中 划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional 否 Boolean 标识属性是否可选，默认为true
optional 否 Boolean 标识属性是否可选，默认为true