请求参数
4.2 终端设备管理
4.2.7 查询终端设备孪生
"removed" : [ ] }}
响应示例
状态码： 200 更新成功
{ "update_nodes" : { "removed" : [ ], "added" : {
"comment" : "hello world", "relation" : "abcd",
"node_ids" : [ "592ede18-d030-4cc1-afb8-34ac1bae47f6" ] }
}}
状态码
状态码 描述
200 更新成功
错误码
请参见错误码。
4.2.7 查询终端设备孪生
功能介绍
该API用于查询终端设备孪生。
调试
您可以在API Explorer中调试该接口。
URI
GET /v2/{project_id}/edgemgr/devices/{device_id}/twin
表4-495 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID
device_id 是 String 终端设备ID
请求参数
表4-496 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。
通过调用IAM服务获取用户 Token接口获取（响应消息头中 X-Subject-Token的值）。
ief-instance-id 否 String 铂金版实例ID，专业版实例为空 值
响应参数
状态码： 200
表4-497 响应 Body 参数
参数 参数类型 描述
property_visit
ors ValueInPrope
rtyVisitors object
孪生属性配置，与access_protocol关联。
twin ValueInTwin Response object
终端设备静态属性信息
access_protoc
ol String 访问协议，有如下选项：
● userdefine：自定义协议
● modbus：modbus协议
● opc-ua：opc-ua协议
表4-498 ValueInPropertyVisitors
参数 参数类型 描述
register_type register_type
object 寄存器类型，value值字段可选为CoilsRegisters、
HoldingRegisters、DiscreteInputsRegisters、
InputRegisters access_mode access_mode
object 访问模式，value值字段可选为r和r/w register_index register_inde
x object 寄存器偏移地址，value值字段取值范围0-65535 register_num register_num
object 寄存器个数 scale_index scale_index
object 缩放因子
original_datat
ype original_data
type object 原始数据类型 expected_dat
atype expected_dat
atype object 期望数据类型 is_registerswa
p is_registersw
ap object 是否交换寄存器顺序
is_swap is_swap
object 是否交换高低字节 sample_interv
al sample_inter
val object 数据采集间隔，取值范围为1-3600 data_min data_min
object 原始数据值区间最小值，与原始数据类型关联 data_max data_max
object 原始数据值区间最大值，与原始数据类型关联 node_id node_id
object 节点id browse_name browse_nam
e object 节点名称
表4-499 register_type
参数 参数类型 描述
value String value 最大长度512， value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional Boolean 标识属性是否可选，默认为true
参数 参数类型 描述 metadata metadata
object 静态属性的元数据信息，默认为{"type":
"string"}
表4-500 metadata
参数 参数类型 描述
type String 属性类型标识，string|int|float|boolean
（boolean类型为true或false），默认为string
表4-501 access_mode
参数 参数类型 描述
value String value 最大长度512， value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional Boolean 标识属性是否可选，默认为true metadata metadata
object 静态属性的元数据信息，默认为{"type":
"string"}
表4-502 metadata
参数 参数类型 描述
type String 属性类型标识，string|int|float|boolean
（boolean类型为true或false），默认为string
表4-503 register_index
参数 参数类型 描述
value String value 最大长度512， value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional Boolean 标识属性是否可选，默认为true metadata metadata
object 静态属性的元数据信息，默认为{"type":
"string"}
表4-504 metadata
参数 参数类型 描述
type String 属性类型标识，string|int|float|boolean
（boolean类型为true或false），默认为string
表4-505 register_num
参数 参数类型 描述
value String value 最大长度512， value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional Boolean 标识属性是否可选，默认为true metadata metadata
object 静态属性的元数据信息，默认为{"type":
"string"}
表4-506 metadata
参数 参数类型 描述
type String 属性类型标识，string|int|float|boolean
（boolean类型为true或false），默认为string
表4-507 scale_index
参数 参数类型 描述
value String value 最大长度512， value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional Boolean 标识属性是否可选，默认为true metadata metadata
object 静态属性的元数据信息，默认为{"type":
"string"}
表4-508 metadata
参数 参数类型 描述
type String 属性类型标识，string|int|float|boolean
（boolean类型为true或false），默认为string
表4-509 original_datatype
参数 参数类型 描述
value String value 最大长度512， value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional Boolean 标识属性是否可选，默认为true metadata metadata
object 静态属性的元数据信息，默认为{"type":
"string"}
表4-510 metadata
参数 参数类型 描述
type String 属性类型标识，string|int|float|boolean
（boolean类型为true或false），默认为string
表4-511 expected_datatype
参数 参数类型 描述
value String value 最大长度512， value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional Boolean 标识属性是否可选，默认为true metadata metadata
object 静态属性的元数据信息，默认为{"type":
"string"}
表4-512 metadata
参数 参数类型 描述
type String 属性类型标识，string|int|float|boolean
（boolean类型为true或false），默认为string
表4-513 is_registerswap
参数 参数类型 描述
value String value 最大长度512， value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
参数 参数类型 描述
optional Boolean 标识属性是否可选，默认为true metadata metadata
object 静态属性的元数据信息，默认为{"type":
"string"}
表4-514 metadata
参数 参数类型 描述
type String 属性类型标识，string|int|float|boolean
（boolean类型为true或false），默认为string
表4-515 is_swap
参数 参数类型 描述
value String value 最大长度512， value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional Boolean 标识属性是否可选，默认为true metadata metadata
object 静态属性的元数据信息，默认为{"type":
"string"}
表4-516 metadata
参数 参数类型 描述
type String 属性类型标识，string|int|float|boolean
（boolean类型为true或false），默认为string
表4-517 sample_interval
参数 参数类型 描述
value String value 最大长度512， value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional Boolean 标识属性是否可选，默认为true metadata metadata
object 静态属性的元数据信息，默认为{"type":
"string"}
表4-518 metadata
参数 参数类型 描述
type String 属性类型标识，string|int|float|boolean
（boolean类型为true或false），默认为string
表4-519 data_min
参数 参数类型 描述
value String value 最大长度512， value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional Boolean 标识属性是否可选，默认为true metadata metadata
object 静态属性的元数据信息，默认为{"type":
"string"}
表4-520 metadata
参数 参数类型 描述
type String 属性类型标识，string|int|float|boolean
（boolean类型为true或false），默认为string
表4-521 data_max
参数 参数类型 描述
value String value 最大长度512， value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional Boolean 标识属性是否可选，默认为true metadata metadata
object 静态属性的元数据信息，默认为{"type":
"string"}
表4-522 metadata
参数 参数类型 描述
type String 属性类型标识，string|int|float|boolean
（boolean类型为true或false），默认为string
表4-523 node_id
参数 参数类型 描述
value String value 最大长度512， value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional Boolean 标识属性是否可选，默认为true metadata metadata
object 静态属性的元数据信息，默认为{"type":
"string"}
表4-524 metadata
参数 参数类型 描述
type String 属性类型标识，string|int|float|boolean
（boolean类型为true或false），默认为string
表4-525 browse_name
参数 参数类型 描述
value String value 最大长度512， value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、
\、/、？、^、=、%、&、:、~
optional Boolean 标识属性是否可选，默认为true metadata metadata
object 静态属性的元数据信息，默认为{"type":
"string"}
表4-526 metadata
参数 参数类型 描述
type String 属性类型标识，string|int|float|boolean
（boolean类型为true或false），默认为string
表4-527 ValueInTwinResponse
参数 参数类型 描述
excepted excepted
object 动态属性的期望信息 actual actual object 动态属性的实际信息
参数 参数类型 描述 metadata metadata
object 动态属性的元数据信息
optional Boolean 标识属性是否可选，默认为true，继承模板的属 性默认为false
表4-528 excepted
参数 参数类型 描述
value String 动态属性的初始值，最大长度512， value允许英 文字母、数字、下划线、中划线、点、逗号、冒 号、/、@、#
表4-529 actual
参数 参数类型 描述
value String 动态属性的初始值，最大长度512， value允许英 文字母、数字、下划线、中划线、点、逗号、冒 号、/、@、#
表4-530 metadata
参数 参数类型 描述
timestamp String 修改时间，UNIX timestamp格式
请求示例
无
响应示例
状态码： 200 ok
{ "access_protocol" : "userdefine", "property_visitors" : { }, "twin" : {
"devicestate" : { "expected" : { "value" : "running", "metadata" : {
"timestamp" : 1523514289 }
},
"actual" : { "value" : "stop", "metadata" : {
"timestamp" : 1523514289 }
},
"optional" : true, "metadata" : { "type" : "string"
} } }}
状态码
状态码 描述
200 ok
错误码
请参见错误码。