文档首页 > > API参考> API> 边缘设备模板管理> 查询边缘设备模板列表

查询边缘设备模板列表

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

功能介绍

查询边缘设备模板列表

URI

GET /v2/{project_id}/edgemgr/device_templates?{name=xxx,limit=xxx,offset=xxx}

表1 参数说明

名称

是否必选

说明

project_id

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

表2 可选的查询检索参数

名称

是否必选

参数类型

说明

name

String

边缘设备名称,模糊匹配

offset

String

查询的起始位置,取值范围1~1000,默认为1000

limit

String

每页显示的条目数量,取值范围为非负整数,默认为0

  • 如果不携带任何检索参数,将返回该租户的所有设备模板信息。
  • 可以同时携带多个其他检索参数,同时生效。

请求消息

响应消息

响应参数

表3 参数说明

名称

参数类型

说明

id

String

边缘设备模板ID

name

String

边缘设备模板名称

description

String

边缘设备模板描述

access_protocol

String

访问协议,有如下选项:

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

attributes

Object

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

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

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

project_id

String

项目ID

created_at

String

创建时间

updated_at

String

更新时间

property_visitors

表26 Object

孪生属性配置,与access_protocol关联

access_config

表25 Object

访问配置,与access_protocol直接关联

tags

Object

标签

twin

Object

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

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

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

响应样例

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

状态码

状态码请参见状态码

分享:

    相关文档

    相关产品

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

提交成功!

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

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

*必选

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

字符长度不能超过200

提交反馈 取消

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

跳转到云社区