文档首页 > > API参考> API> 边缘设备模板管理> 创建边缘设备模板

创建边缘设备模板

分享
更新时间: 2020/04/16 GMT+08:00

功能介绍

创建一个边缘设备模板

URI

POST /v2/{project_id}/edgemgr/device_templates

表1 参数说明

名称

是否必选

说明

project_id

项目ID,获取方法请参见获取项目ID

请求消息

表2 参数说明

名称

是否必选

参数类型

说明

name

String

设备模板名称,只允许中文字符、英文字母、数字、下划线、中划线,最大长度64

access_protocol

String

访问协议,有如下选项:

  • userdefine:自定义协议
  • modbus:modbus协议
  • opc-ua:opc-ua协议

description

String

设备模板描述,最大长度255

attributes

Object

边缘设备静态属性,最多64个键值。

key为属性名称,value格式请参见表6,示例如下。

"attributes": {
            "username": {
                "value": "test",
                "optional": true,
                "metadata": {
                    "type": "string"
                }
            }
        }

twin

Object

边缘设备动态属性,最多64个键值。

key为属性名称,value格式请参见表7,示例如下。

"twin": {
            "devicestate": {
                "optional": true,
                "expected": {
                    "value": "running"
                },
                "metadata": {
                    "type": "string"
                }
            }
        }

tags

Array of 表27 Object

设备模板标签

property_visitors

表25 object

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

请求样例

{
    "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"
        }
    }
}

响应消息

表3 参数说明

名称

参数类型

说明

id

String

边缘设备模板ID

name

String

边缘设备模板名称

description

String

边缘设备模板描述

attributes

Object

边缘设备静态属性,最多64个键值。

key为属性名称,value格式请参见表6,示例如下。

"attributes": {
            "username": {
                "value": "test",
                "optional": true,
                "metadata": {
                    "type": "string"
                }
            }
        }

twin

Object

边缘设备动态属性,最多64个键值。

key为属性名称,value格式请参见表21,示例如下。

"devicestate":{ 
                      "expected":{ 
                           "value":"running", 
                           "metadata":{ 
                                "timestamp":1536822119463 
                                } 
                           }, 
                     "optional":true, 
                     "metadata":{ "type":"string" } 
                     }

project_id

String

项目ID

created_at

String

创建时间

updated_at

String

更新时间

property_visitors

表25 object

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

tags

Array of 表27 Object

设备模板标签

响应样例

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

状态码

状态码请参见状态码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问