更新时间:2023-11-01 GMT+08:00
分享

创建终端设备模板

功能介绍

创建一个终端设备模板

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v2/{project_id}/edgemgr/device-templates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目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

EdgemgrDeviceReq object

终端设备属性

表4 EdgemgrDeviceReq

参数

是否必选

参数类型

描述

name

String

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

access_protocol

String

访问协议,有如下选项:

  • userdefine:自定义协议

  • modbus:modbus协议

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

description

String

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

attributes

Map<String,ValueInAttributes>

静态属性

twin

Map<String,ValueInTwin>

终端设备动态属性

tags

ResourceTag object

标签属性

property_visitors

Map<String,ValueInPropertyVisitors>

孪生属性配置

表5 ValueInTwin

参数

是否必选

参数类型

描述

excepted

Excepted object

动态属性的期望信息

optional

Boolean

动态属性的实际信息

metadata

metadata object

动态属性的元数据信息

表6 Excepted

参数

是否必选

参数类型

描述

value

String

动态属性的初始值,最大长度512,value允许英文字母、数字、下划线、中划线、点、逗号、冒号、/、@、+、?、^、=、%、&、~、#、!、*

metadata

metadata object

期望值设置的时间信息

表7 metadata

参数

是否必选

参数类型

描述

type

String

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

表8 ResourceTag

参数

是否必选

参数类型

描述

key

String

键。最大长度36个unicode字符。 不能为空,只能包含大小写字母,数字,中划线“-”,下划线“_”。

value

String

值。每个值最大长度43个unicode字符,删除时如果value有值按照key/value删除,如果value没值,则按照key删除。 不能为空,只能包含大小写字母,数字,中划线“-”,下划线“_”。

表9 ValueInPropertyVisitors

参数

是否必选

参数类型

描述

register_type

ValueInAttributes object

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

access_mode

ValueInAttributes object

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

register_index

ValueInAttributes object

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

register_num

ValueInAttributes object

寄存器个数

scale_index

ValueInAttributes object

缩放因子

original_datatype

ValueInAttributes object

原始数据类型

expected_datatype

ValueInAttributes object

期望数据类型

is_registerswap

ValueInAttributes object

是否交换寄存器顺序

is_swap

ValueInAttributes object

是否交换高低字节

sample_interval

ValueInAttributes object

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

data_min

ValueInAttributes object

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

data_max

ValueInAttributes object

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

node_id

ValueInAttributes object

节点id

browse_name

ValueInAttributes object

节点名称

表10 ValueInAttributes

参数

是否必选

参数类型

描述

value

String

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

optional

Boolean

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

metadata

Metadata object

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

表11 Metadata

参数

是否必选

参数类型

描述

type

String

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

响应参数

状态码: 201

表12 响应Body参数

参数

参数类型

描述

device_template

EdgemgrDevice object

终端设备属性

表13 EdgemgrDevice

参数

参数类型

描述

id

String

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

name

String

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

access_protocol

String

访问协议,有如下选项:

  • userdefine:自定义协议

  • modbus:modbus协议

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

description

String

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

attributes

Map<String,ValueInAttributes>

静态属性

twin

Map<String,ValueInTwinResponse>

终端设备静态属性信息

project_id

String

项目ID

created_at

String

创建时间

updated_at

String

更新时间

property_visitors

Map<String,ValueInPropertyVisitors>

孪生属性配置

tags

ResourceTag object

标签属性

表14 ValueInTwinResponse

参数

参数类型

描述

excepted

ExceptedActual object

动态属性的期望信息

actual

ExceptedActual object

动态属性的实际信息

metadata

Metadata object

动态属性的元数据信息

optional

Boolean

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

表15 ExceptedActual

参数

参数类型

描述

value

String

动态属性的初始值,最大长度512,value允许英文字母、数字、下划线、中划线、点、逗号、冒号、/、@、+、?、^、=、%、&、~、#、!、*

表16 ValueInPropertyVisitors

参数

参数类型

描述

register_type

ValueInAttributes object

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

access_mode

ValueInAttributes object

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

register_index

ValueInAttributes object

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

register_num

ValueInAttributes object

寄存器个数

scale_index

ValueInAttributes object

缩放因子

original_datatype

ValueInAttributes object

原始数据类型

expected_datatype

ValueInAttributes object

期望数据类型

is_registerswap

ValueInAttributes object

是否交换寄存器顺序

is_swap

ValueInAttributes object

是否交换高低字节

sample_interval

ValueInAttributes object

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

data_min

ValueInAttributes object

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

data_max

ValueInAttributes object

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

node_id

ValueInAttributes object

节点id

browse_name

ValueInAttributes object

节点名称

表17 ValueInAttributes

参数

参数类型

描述

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 ResourceTag

参数

参数类型

描述

key

String

键。最大长度36个unicode字符。 不能为空,只能包含大小写字母,数字,中划线“-”,下划线“_”。

value

String

值。每个值最大长度43个unicode字符,删除时如果value有值按照key/value删除,如果value没值,则按照key删除。 不能为空,只能包含大小写字母,数字,中划线“-”,下划线“_”。

请求示例

创建终端设备模板,访问协议为自定义协议。

{
  "device_template" : {
    "name" : "CameraTemplate",
    "access_protocol" : "userdefine",
    "description" : "This is a camera template",
    "attributes" : {
      "cameraURL" : {
        "value" : "127.0.0.1",
        "optional" : true,
        "metadata" : {
          "type" : "string"
        }
      }
    },
    "twin" : {
      "runstate" : {
        "expected" : {
          "value" : "running"
        },
        "optional" : false,
        "metadata" : {
          "type" : "string"
        }
      }
    },
    "tags" : {
      "dev" : "dev1"
    }
  }
}

响应示例

状态码: 201

ok

{
  "device_template" : {
    "name" : "CameraTemplate",
    "description" : "This is a camera template",
    "created_at" : "2018-07-16T04:01:21.212072",
    "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"
        }
      }
    }
  }
}

状态码

状态码

描述

201

ok

错误码

请参见错误码

相关文档