查询终端设备模板 - ShowDeviceTemplate

功能介绍

查询一个终端设备模板

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID
device_template_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，专业版实例为空值。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
device_template	EdgemgrDevice object	终端设备属性

表4 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	标签属性

表5 ValueInTwinResponse
参数	参数类型	描述
excepted	ExceptedActual object	动态属性的期望信息
actual	ExceptedActual object	动态属性的实际信息
metadata	Metadata object	动态属性的元数据信息
optional	Boolean	标识属性是否可选，默认为true，继承模板的属性默认为false

表6 ExceptedActual
参数	参数类型	描述
value	String	动态属性的初始值，最大长度512，value允许英文字母、数字、下划线、中划线、点、逗号、冒号、/、@、+、?、^、=、%、&、~、#、!、*

表7 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	节点名称

表8 ValueInAttributes
参数	参数类型	描述
value	String	value 最大长度512，value允许英文字母、数字、下划线、中划线、点、逗号、冒号、/、@、+、?、^、=、%、&、~、#、!、*
optional	Boolean	标识属性是否可选，默认为true
metadata	Metadata object	静态属性的元数据信息，默认为{"type": "string"}

表9 Metadata
参数	参数类型	描述
type	String	属性类型标识，string\|int\|float\|boolean（boolean类型为true或false），默认为string

**表10** ResourceTag
参数	参数类型	描述
key	String	键。最大长度36个unicode字符。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_”。
value	String	值。每个值最大长度43个unicode字符，删除时如果value有值按照key/value删除，如果value没值，则按照key删除。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_”。

请求示例

无

响应示例

状态码：200

{
  "device_template" : {
    "property_visitors" : { },
    "description" : "This is a camera template",
    "tags" : { },
    "created_at" : "2019-11-07T03:20:04.041160+08:00",
    "updated_at" : "2019-11-07T03:21:00.347476+08:00",
    "access_protocol" : "userdefine",
    "twin" : {
      "runstate" : {
        "expected" : {
          "value" : "running"
        },
        "optional" : true,
        "metadata" : {
          "type" : "string"
        }
      }
    },
    "attributes" : {
      "cameraURL" : {
        "optional" : true,
        "value" : "127.0.0.1",
        "metadata" : {
          "type" : "string"
        }
      }
    },
    "project_id" : "ed202955e111444e8ced21a1bd75fc59",
    "id" : "42e20164-5158-4316-a821-5fe127c483b0",
    "name" : "CameraTemplate"
  }
}