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

更新终端设备孪生

功能介绍

该API用于更新终端设备孪生。

调试

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

URI

PUT /v2/{project_id}/edgemgr/devices/{device_id}/twin

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

device_id

String

设备ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

ief-instance-id

String

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

表3 请求Body参数

参数

是否必选

参数类型

描述

twin

ValueInTwin object

终端设备动态属性

property_visitors

property_visitors object

孪生属性配置,与access_protocol关联。

表4 ValueInTwin

参数

是否必选

参数类型

描述

excepted

excepted object

动态属性的期望信息

optional

Boolean

动态属性的期望信息

metadata

Metadata object

期望值设置的时间信息

表5 excepted

参数

是否必选

参数类型

描述

value

String

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

metadata

metadata object

期望值设置的时间信息

表6 metadata

参数

是否必选

参数类型

描述

timestamp

String

修改时间,UNIX timestamp格式

表7 Metadata

参数

是否必选

参数类型

描述

type

String

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

表8 property_visitors

参数

是否必选

参数类型

描述

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

节点名称

表9 register_type

参数

是否必选

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表10 metadata

参数

是否必选

参数类型

描述

type

String

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

表11 access_mode

参数

是否必选

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表12 metadata

参数

是否必选

参数类型

描述

type

String

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

表13 register_index

参数

是否必选

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表14 metadata

参数

是否必选

参数类型

描述

type

String

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

表15 register_num

参数

是否必选

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表16 metadata

参数

是否必选

参数类型

描述

type

String

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

表17 scale_index

参数

是否必选

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表18 metadata

参数

是否必选

参数类型

描述

type

String

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

表19 original_datatype

参数

是否必选

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表20 metadata

参数

是否必选

参数类型

描述

type

String

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

表21 expected_datatype

参数

是否必选

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表22 metadata

参数

是否必选

参数类型

描述

type

String

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

表23 is_registerswap

参数

是否必选

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表24 metadata

参数

是否必选

参数类型

描述

type

String

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

表25 is_swap

参数

是否必选

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表26 metadata

参数

是否必选

参数类型

描述

type

String

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

表27 sample_interval

参数

是否必选

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表28 metadata

参数

是否必选

参数类型

描述

type

String

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

表29 data_min

参数

是否必选

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表30 metadata

参数

是否必选

参数类型

描述

type

String

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

表31 data_max

参数

是否必选

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表32 metadata

参数

是否必选

参数类型

描述

type

String

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

表33 node_id

参数

是否必选

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表34 metadata

参数

是否必选

参数类型

描述

type

String

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

表35 browse_name

参数

是否必选

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表36 metadata

参数

是否必选

参数类型

描述

type

String

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

响应参数

状态码: 200

表37 响应Body参数

参数

参数类型

描述

property_visitors

ValueInPropertyVisitors object

孪生属性配置,与access_protocol关联。

twin

ValueInTwinResponse object

终端设备静态属性信息

表38 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

节点名称

表39 register_type

参数

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表40 metadata

参数

参数类型

描述

type

String

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

表41 access_mode

参数

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表42 metadata

参数

参数类型

描述

type

String

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

表43 register_index

参数

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表44 metadata

参数

参数类型

描述

type

String

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

表45 register_num

参数

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表46 metadata

参数

参数类型

描述

type

String

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

表47 scale_index

参数

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表48 metadata

参数

参数类型

描述

type

String

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

表49 original_datatype

参数

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表50 metadata

参数

参数类型

描述

type

String

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

表51 expected_datatype

参数

参数类型

描述

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 is_registerswap

参数

参数类型

描述

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 is_swap

参数

参数类型

描述

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 sample_interval

参数

参数类型

描述

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 data_min

参数

参数类型

描述

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 data_max

参数

参数类型

描述

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 node_id

参数

参数类型

描述

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 browse_name

参数

参数类型

描述

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 ValueInTwinResponse

参数

参数类型

描述

excepted

excepted object

动态属性的期望信息

actual

actual object

动态属性的实际信息

metadata

metadata object

动态属性的元数据信息

optional

Boolean

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

表68 excepted

参数

参数类型

描述

value

String

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

表69 actual

参数

参数类型

描述

value

String

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

表70 metadata

参数

参数类型

描述

timestamp

String

修改时间,UNIX timestamp格式

请求示例

{
  "twin" : {
    "devicestate" : {
      "expected" : {
        "value" : "running"
      }
    }
  },
  "property_visitors" : { }
}

响应示例

状态码: 200

ok

"{ \n    \"twin\": { \n        \"devicestate\": { \n            \"expected\": { \n                \"value\": \"running\", \n                \"metadata\": { \n                    \"timestamp\": 1523514289 \n                } \n            }, \n            \"actual\": { \n                \"value\": \"stop\", \n                \"metadata\": { \n                    \"timestamp\": 1523514289 \n                } \n            }, \n            \"optional\": true, \n            \"metadata\": { \n                \"type\": \"string\" \n            } \n        } \n    }, \n    \"property_visitors\": {} \n}"

状态码

状态码

描述

200

ok

错误码

请参见错误码

分享:

    相关文档

    相关产品

close