更新时间:2021-12-27 GMT+08:00
分享

查询终端设备模板列表

功能介绍

查询终端设备模板列表

调试

您可以在API Explorer中调试该接口。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

表2 Query参数

参数

是否必选

参数类型

描述

name

String

终端设备名称,模糊匹配

offset

String

查询的起始位置,取值范围为非负整数,默认为0

limit

String

每页显示的条目数量,取值范围1~1000,默认为1000

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

ief-instance-id

String

铂金版实例ID,专业版实例为空值

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

device_templates

Array of EdgemgrDevice objects

终端设备属性

count

Integer

模板数量

表5 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

创建时间

property_visitors

Map<String,ValueInPropertyVisitors>

孪生属性配置

tags

ResourceTag object

标签属性

表6 ValueInAttributes

参数

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表7 metadata

参数

参数类型

描述

type

String

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

表8 ValueInTwinResponse

参数

参数类型

描述

excepted

excepted object

动态属性的期望信息

actual

actual object

动态属性的实际信息

metadata

metadata object

动态属性的元数据信息

optional

Boolean

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

表9 excepted

参数

参数类型

描述

value

String

动态属性的初始值,最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、冒号、/、@、#

表10 actual

参数

参数类型

描述

value

String

动态属性的初始值,最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、冒号、/、@、#

表11 metadata

参数

参数类型

描述

timestamp

String

修改时间,UNIX timestamp格式

表12 ValueInPropertyVisitors

参数

参数类型

描述

register_type

register_type object

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

access_mode

access_mode object

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

register_index

register_index object

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

register_num

register_num object

寄存器个数

scale_index

scale_index object

缩放因子

original_datatype

original_datatype object

原始数据类型

expected_datatype

expected_datatype object

期望数据类型

is_registerswap

is_registerswap object

是否交换寄存器顺序

is_swap

is_swap object

是否交换高低字节

sample_interval

sample_interval object

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

data_min

data_min object

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

data_max

data_max object

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

node_id

node_id object

节点id

browse_name

browse_name object

节点名称

表13 register_type

参数

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表14 metadata

参数

参数类型

描述

type

String

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

表15 access_mode

参数

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表16 metadata

参数

参数类型

描述

type

String

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

表17 register_index

参数

参数类型

描述

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 register_num

参数

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表20 metadata

参数

参数类型

描述

type

String

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

表21 scale_index

参数

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表22 metadata

参数

参数类型

描述

type

String

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

表23 original_datatype

参数

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表24 metadata

参数

参数类型

描述

type

String

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

表25 expected_datatype

参数

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表26 metadata

参数

参数类型

描述

type

String

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

表27 is_registerswap

参数

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表28 metadata

参数

参数类型

描述

type

String

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

表29 is_swap

参数

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表30 metadata

参数

参数类型

描述

type

String

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

表31 sample_interval

参数

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表32 metadata

参数

参数类型

描述

type

String

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

表33 data_min

参数

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表34 metadata

参数

参数类型

描述

type

String

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

表35 data_max

参数

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表36 metadata

参数

参数类型

描述

type

String

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

表37 node_id

参数

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表38 metadata

参数

参数类型

描述

type

String

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

表39 browse_name

参数

参数类型

描述

value

String

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

optional

Boolean

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

metadata

metadata object

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

表40 metadata

参数

参数类型

描述

type

String

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

表41 ResourceTag

参数

参数类型

描述

key

String

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

value

String

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

请求示例

响应示例

状态码: 200

ok

{
  "count" : 1,
  "device_templates" : [ {
    "property_visitors" : { },
    "description" : "",
    "tags" : {
      "key1" : "value1"
    },
    "created_at" : "2019-10-09T00:51:11.890571+08:00",
    "updated_at" : null,
    "access_protocol" : "userdefine",
    "twin" : { },
    "attributes" : {
      "ggg" : {
        "optional" : true,
        "value" : "ggg",
        "metadata" : {
          "type" : "string"
        }
      }
    },
    "project_id" : "13b43583216e426b9dc9fad4000e9e1a",
    "id" : "3950b024-7716-4580-8b85-4ab4bd3eeef0",
    "name" : "mmmmmmm"
  } ]
}

状态码

状态码

描述

200

ok

错误码

请参见错误码

分享:

    相关文档

    相关产品

close