更新终端设备模板

功能介绍

该API用于更新一个终端设备模板。

URI

PUT /v2/{project_id}/edgemgr/device-templates/{device_template_id}

表1 Path参数
名称	是否必选	说明
project_id	是	项目ID，获取方法请参见获取项目ID。
device_template_id	是	设备模板ID

请求消息

请求参数

表2 请求Header参数
参数	是否必选	类型	描述
Content-Type	是	String	消息体的类型（格式）推荐您使用默认值application/json。
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
ief-instance-id	否	String	铂金版实例ID，专业版实例为空值

表3 请求Body参数
名称	是否必选	参数类型	说明
device_template	是	表4 device_template object	设备模板

表4 device_template
名称	是否必选	参数类型	说明
description	否	String	设备模板描述，最大长度255
attributes	否	Object	终端设备静态属性，最多64个键值。 key为属性名称，value格式请参见表6，示例如下。 "attributes": { "value": "test", "optional": true, "metadata": { "type": "string" } }
tags	否	表9 object	设备模板标签，key-value键值对形式。
access_protocol	否	String	访问协议，有如下选项： userdefine：自定义协议 modbus：modbus协议 opc-ua：opc-ua协议
property_visitors	否	表25 object	孪生属性配置，与access_protocol关联。

表5 value_in_twin
名称	是否必选	参数类型	说明
excepted	是	表6 object	动态属性的期望信息
optional	否	Boolean	标识属性是否可选，默认为true，继承模板的属性默认为false
metadata	否	表7 object	动态属性的元数据信息

表6 excepted
名称	是否必选	参数类型	说明
value	是	String	动态属性的初始值，最大长度512，value允许英文字母、数字、下划线、中划线、点、逗号、冒号、/、@、#
metadata	否	表8 object	期望值设置的时间信息

表7 metadata
名称	是否必选	参数类型	说明
type	是	String	属性类型标识，string\|int\|float\|boolean（boolean类型为true或false），默认为string

表8 metadata
名称	是否必选	参数类型	说明
timestamp	否	String	修改时间，UNIX timestamp格式

表9 ResourceTag
名称	是否必选	参数类型	说明
key	否	String	标签key值。长度取值范围为1~36，仅允许大小写英文字母、数字、下划线、中划线。
value	否	String	标签value值。长度取值范围为0~43，仅允许大小写英文字母、数字、下划线、中划线。

请求示例

{    
         "device_template":{
         "description":"This is a camera template",
         "attributes":{
             "cameraURL":{
                 "value":"127.0.0.1",
                 "metadata":{
                     "type":"string"
                 }
             }
         },
         "twin":{
             "runstate":{
                 "expected":{
                     "value":"running"
                 },
                 "metadata":{
                     "type":"string"
                 }
             }
         }
     }
}

响应消息

响应参数

**表10** 响应Body参数
参数	类型	描述
device_template	表7 object	终端设备模板详细信息

响应示例

{
     "device_template":{
         "name":"CameraTemplate",
         "description":"This is a camera template",
         "created_at":"2018-07-16T04:01:21.212072",
         "updated_at":"2018-07-18T04:01:21.212017",
         "access_protocol": "userdefine",
         "project_id":"d16e6eb6cc0d49a0941df2f31285757a",
         "id":"82952098-ec24-4643-94e6-9989174fce05",
         "attributes":{
             "cameraURL":{
                 "value":"127.0.0.1",
                 "metadata":{
                     "type":"string"
                 }
             },
             "twin":{
                 "runstate":{
                     "expected":{
                         "value":"running"
                     },
                     "metadata":{
                         "type":"string"
                     }
                 }
             }
         }
     }
 }