• 沒有找到結果。

查询终端设备详情

请求参数

4.2 终端设备管理

4.2.4 查询终端设备详情

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

URI

GET /v2/{project_id}/edgemgr/devices/{device_id}

4-407 路径参数

参数 是否必选 参数类型 描述

project_id 是 String 项目ID

device_id 是 String 终端设备ID

请求参数

4-408 请求 Header 参数

参数 是否必选 参数类型 描述

X-Auth-Token 是 String 用户Token。

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

ief-instance-id 否 String 铂金版实例ID,专业版实例为空 值

响应参数

状态码: 200

4-409 响应 Body 参数

参数 参数类型 描述

device Device object 终端设备属性

4-410 Device

参数 参数类型 描述

id String 终端设备ID,只允许英文字母、数字、下划线、

中划线,必须以英文字母和数字开头,长度限制 为24~64之间

name String 终端设备名称,只允许中文字符、英文字母、数

字、下划线、中划线,长度限制为1~64 access_protoc

ol String 访问协议,有如下选项:

● userdefine:自定义协议

● modbus:modbus协议

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

参数 参数类型 描述

description String 终端设备描述,最大长度255,不允许^ ~ # $ %

& * < > ( ) [ ] { } ' " \ project_id String 项目ID

created_at String 创建时间 updated_at String 更新时间 attributes Map<String,V

alueInAttribu tes>

静态属性

connection_ty

pe String 连接类型,默认为edge

twin Map<String,V alueInTwinR esponse>

终端设备静态属性信息

access_config AccessConfig

object 访问配置,与access_protocol直接关联 property_visit

ors Map<String,V alueInProper tyVisitors>

孪生属性配置

4-411 ValueInAttributes

参数 参数类型 描述

value String value 最大长度512, value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、

\、/、?、^、=、%、&、:、~

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

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

"string"}

4-412 metadata

参数 参数类型 描述

type String 属性类型标识,string|int|float|boolean

(boolean类型为true或false),默认为string

4-413 ValueInTwinResponse

参数 参数类型 描述

excepted excepted

object 动态属性的期望信息 actual actual object 动态属性的实际信息 metadata metadata

object 动态属性的元数据信息

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

4-414 excepted

参数 参数类型 描述

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

4-415 actual

参数 参数类型 描述

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

4-416 metadata

参数 参数类型 描述

timestamp String 修改时间,UNIX timestamp格式

4-417 AccessConfig

参数 参数类型 描述

protocol_type protocol_typ

e object 设备访问类型,包含:

● userdefine:自定义访问协议;

● TCP:modbus访问协议中的一种访问形式;

● RTU:modbus访问协议中的一种访问形式;

● opc-ua:opc-ua访问协议;

参数 参数类型 描述 protocol_nam

e protocol_na

me object 设备访问名称

slave_id slave_id

object Modbus设备访问id(0-255)

ip ip object TCP传输模式下访问ip地址(标准ipv4地址)

port port object TCP传输模式下访问端口(0-65535)

serial_port serial_port

object RTU传输模式下串口配置 baud_rate baud_rate

object RTU传输模式下波特率配置,value值字段可选 50、75、110、150、200、300、1200、1800、

2400、9600、19200、38400、57600、115200 data_bits data_bits

object RTU传输模式下数据位配置,value值字段包括 5、6、7、8

stop_bits stop_bits

object RTU传输模式下停止位配置,value值字段包含 1、2

parity_bits parity_bits

object RTU传输模式下校验位配置,value值字段可选为 none、odd、even

url url object OPC-UA协议下访问url地址

sec_mode sec_mode

object OPC-UA协议下访问安全模式 sec_policy sec_policy

object OPC-UA协议下访问安全策略 auth_type auth_type

object OPC-UA协议下访问认证类型,value值字段可选 为0、1、2、3

username username

object OPC-UA协议下,采用密码认证时用户名字段 password password

object OPC-UA协议下,采用密码认证时密码字段 private_key private_key

object OPC-UA协议下,采用证书认证时私钥字段,

value字段为base64格式 certificate certificate

object OPC-UA协议下,采用证书认证时证书字段,

value字段为base64格式 timeout timeout

object OPC-UA协议下访问超时配置,默认为5s

4-418 protocol_type

参数 参数类型 描述

value String value 最大长度512, value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、

\、/、?、^、=、%、&、:、~

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

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

"string"}

4-419 metadata

参数 参数类型 描述

type String 属性类型标识,string|int|float|boolean

(boolean类型为true或false),默认为string

4-420 protocol_name

参数 参数类型 描述

value String value 最大长度512, value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、

\、/、?、^、=、%、&、:、~

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

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

"string"}

4-421 metadata

参数 参数类型 描述

type String 属性类型标识,string|int|float|boolean

(boolean类型为true或false),默认为string

4-422 slave_id

参数 参数类型 描述

value String value 最大长度512, value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、

\、/、?、^、=、%、&、:、~

参数 参数类型 描述

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

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

"string"}

4-423 metadata

参数 参数类型 描述

type String 属性类型标识,string|int|float|boolean

(boolean类型为true或false),默认为string

4-424 ip

参数 参数类型 描述

value String value 最大长度512, value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、

\、/、?、^、=、%、&、:、~

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

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

"string"}

4-425 metadata

参数 参数类型 描述

type String 属性类型标识,string|int|float|boolean

(boolean类型为true或false),默认为string

4-426 port

参数 参数类型 描述

value String value 最大长度512, value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、

\、/、?、^、=、%、&、:、~

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

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

"string"}

4-427 metadata

参数 参数类型 描述

type String 属性类型标识,string|int|float|boolean

(boolean类型为true或false),默认为string

4-428 serial_port

参数 参数类型 描述

value String value 最大长度512, value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、

\、/、?、^、=、%、&、:、~

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

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

"string"}

4-429 metadata

参数 参数类型 描述

type String 属性类型标识,string|int|float|boolean

(boolean类型为true或false),默认为string

4-430 baud_rate

参数 参数类型 描述

value String value 最大长度512, value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、

\、/、?、^、=、%、&、:、~

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

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

"string"}

4-431 metadata

参数 参数类型 描述

type String 属性类型标识,string|int|float|boolean

(boolean类型为true或false),默认为string

4-432 data_bits

参数 参数类型 描述

value String value 最大长度512, value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、

\、/、?、^、=、%、&、:、~

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

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

"string"}

4-433 metadata

参数 参数类型 描述

type String 属性类型标识,string|int|float|boolean

(boolean类型为true或false),默认为string

4-434 stop_bits

参数 参数类型 描述

value String value 最大长度512, value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、

\、/、?、^、=、%、&、:、~

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

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

"string"}

4-435 metadata

参数 参数类型 描述

type String 属性类型标识,string|int|float|boolean

(boolean类型为true或false),默认为string

4-436 parity_bits

参数 参数类型 描述

value String value 最大长度512, value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、

\、/、?、^、=、%、&、:、~

参数 参数类型 描述

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

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

"string"}

4-437 metadata

参数 参数类型 描述

type String 属性类型标识,string|int|float|boolean

(boolean类型为true或false),默认为string

4-438 url

参数 参数类型 描述

value String value 最大长度512, value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、

\、/、?、^、=、%、&、:、~

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

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

"string"}

4-439 metadata

参数 参数类型 描述

type String 属性类型标识,string|int|float|boolean

(boolean类型为true或false),默认为string

4-440 sec_mode

参数 参数类型 描述

value String value 最大长度512, value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、

\、/、?、^、=、%、&、:、~

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

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

"string"}

4-441 metadata

参数 参数类型 描述

type String 属性类型标识,string|int|float|boolean

(boolean类型为true或false),默认为string

4-442 sec_policy

参数 参数类型 描述

value String value 最大长度512, value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、

\、/、?、^、=、%、&、:、~

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

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

"string"}

4-443 metadata

参数 参数类型 描述

type String 属性类型标识,string|int|float|boolean

(boolean类型为true或false),默认为string

4-444 auth_type

参数 参数类型 描述

value String value 最大长度512, value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、

\、/、?、^、=、%、&、:、~

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

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

"string"}

4-445 metadata

参数 参数类型 描述

type String 属性类型标识,string|int|float|boolean

(boolean类型为true或false),默认为string

4-446 username

参数 参数类型 描述

value String value 最大长度512, value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、

\、/、?、^、=、%、&、:、~

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

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

"string"}

4-447 metadata

参数 参数类型 描述

type String 属性类型标识,string|int|float|boolean

(boolean类型为true或false),默认为string

4-448 password

参数 参数类型 描述

value String value 最大长度512, value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、

\、/、?、^、=、%、&、:、~

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

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

"string"}

4-449 metadata

参数 参数类型 描述

type String 属性类型标识,string|int|float|boolean

(boolean类型为true或false),默认为string

4-450 private_key

参数 参数类型 描述

value String value 最大长度512, value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、

\、/、?、^、=、%、&、:、~

参数 参数类型 描述

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

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

"string"}

4-451 metadata

参数 参数类型 描述

type String 属性类型标识,string|int|float|boolean

(boolean类型为true或false),默认为string

4-452 certificate

参数 参数类型 描述

value String value 最大长度512, value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、

\、/、?、^、=、%、&、:、~

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

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

"string"}

4-453 metadata

参数 参数类型 描述

type String 属性类型标识,string|int|float|boolean

(boolean类型为true或false),默认为string

4-454 timeout

参数 参数类型 描述

value String value 最大长度512, value允许英文字母、数 字、下划线、中划线、点、逗号、@、#、+、

\、/、?、^、=、%、&、:、~

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

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

"string"}

4-455 metadata

4-455 metadata