文档首页 > > API参考> 数据结构

数据结构

分享
更新时间: 2019/11/11 GMT+08:00
表1 node

参数

参数类型

描述

id

String

边缘节点ID

name

String

边缘节点名称

description

String

边缘节点描述

created_at

String

创建时间

updated_at

String

更新时间

project_id

String

项目ID

private_key

String

私钥

certificate

String

证书

ca

String

根证书

state

String

边缘节点状态

  • UNCONNECTED(未注册)
  • RUNNING(运行中)
  • FAIL(故障)
  • STOPPED(停用)
  • UPGRADING(升级中)
  • FREEZE(冻结)

package

String

将certificate/ca/private_key打成tar.gz的包,然后用base64编码

master_url

String

云端服务URL

cpu

Integer

边缘节点CPU核心数

memory

Integer

边缘节点内存大小,单位M

os_name

String

边缘节点操作系统名称

os_version

String

边缘节点操作系统版本

pause_docker_image

String

pause容器镜像URL

arch

String

边缘节点架构

os_type

String

边缘节点操作系统类型

deployment_num

Integer

部署在该边缘节点上的应用实例个数

enable_gpu

Boolean

边缘节点是否开启GPU,默认为false

log_configs

表2 object

边缘设备日志配置

device_infos

表3 object

关联设备信息

edged_version

String

edged版本

gpu_num

String

gpu个数

host_name

String

主机名称

host_ips

Array of strings

主机IP

relation

String

与device绑定关系名称(通过device id查询node时有值)

comment

String

与device绑定关系描述(通过device id查询node时有值)

gpu_info

表4 object

gpu型号和gpu memory大小

container_runtime_version

String

容器运行时版本

device_num

Integer

关联设备数量

enable_npu

Boolean

设备是否开启NPU

gpu_type

String

NPU型号

gpu_memory

Integer

NPU内存大小

nics

Array of 表29 object

节点网卡和对应IP地址信息

host_name

String

边缘节点主机名

ief_node_version

String

边缘节点版本

product_id

String

产品ID(通过产品证书方式纳管)

group_ids

Array of String

节点组ID(一个节点属于多个节点组)

upgrade_history

Array of 表30 object

节点安装或升级记录

attributes

Array of 表27 objects

边缘节点的属性

docker_enable

Boolean

节点是否开启Docker

mqtt_mode

String

mqtt集成模式

  • internal:edgecore内置mqtt
  • external:外置开源mqtt

mqtt_external

String

外置开源mqtt地址

mqtt_internal

String

edgecore内置的mqtt地址

node_type

String

节点类型,默认为空,非空时为小站节点

ntp_configs

表31

ntp配置

error_reason

String

节点故障原因

表2 log_configs

名称

是否必选

参数类型

说明

size

Integer

应用日志文件大小限制,单位MB,默认50,取值范围10-1000

level

String

当type为LTS时,应用级日志可配置为On或Off;系统级日志可配置为Off/Error/Warning/Info/Debug

rotate_num

Integer

应用日志rotate个数,默认5,取值范围1-10

rotate_period

String

应用日志rotate周期,可选项: daily/monthly/weekly/yearly

type

String

  • LTS:将日志发送到AOM
  • local:本地日志

component

String

app:部署到边缘设备上的应用的日志, system: 边缘设备上系统的日志

表3 device_infos

名称

是否必须

参数类型

说明

relation

String

设备和节点关系的名称,只允许中文字符、英文字母、数字、下划线、中划线,最大长度64

comment

String

设备和节点关系的描述,最大长度64,不允许^ ~ # $ % & * < > ( ) [ ] { } ' " \

device_ids

Array of strings

设备ID列表

表4 gpu_info

名称

参数类型

说明

name

String

GPU名称

type

String

GPU类型

capacity

Integer

GPU memory大小,单位MB

表5 device

名称

参数类型

说明

id

String

边缘设备ID

name

String

边缘设备名称

description

String

边缘设备描述

state

String

边缘设备的状态,非直连设备为unknown,直连设备默认为enable

last_online

String

边缘设备最后活跃时间

project_id

String

项目ID

attributes

表7 object

静态属性信息

created_at

String

创建时间

updated_at

String

更新时间

表6 direct connection device

名称

参数类型

说明

id

String

边缘设备ID

name

String

边缘设备名称

description

String

边缘设备描述

private_key

String

私钥

certificate

String

证书

ca

String

根证书

attributes

表7 object

属性列表

package

String

将 certificate/ca/private_key打成 tar.gz 的包,然后用 base64 编码

project_id

String

项目ID

registered_at

String

注册时间,UNIX timestamp格式

表7 value in attributes

名称

是否必选

参数类型

说明

value

String

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

optional

Boolean

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

metadata

表10 object

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

表8 value in twin

名称

是否必选

参数类型

说明

excepted

表9 object

动态属性的期望信息

optional

Boolean

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

metadata

表10 object

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

表9 excepted

名称

是否必选

参数类型

说明

value

String

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

表10 metadata

名称

是否必选

参数类型

说明

type

String

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

表11 envs

名称

是否必选

参数类型

说明

name

String

环境变量的key,由大小写字母或下划线开头,由数字、大小写字母、下划线组成,最大长度2048个字符

value

String

环境变量的value,最大长度2048个字符

表12 volumes

名称

是否必选

参数类型

说明

name

String

卷名称,小写字母或数字,最长63个字符

type

String

卷的类型,支持configMap,secret,emptyDir,hostPath

source

String

卷来源,type为hostPath时输入路径,要求以/开头,后面可包含中划线,反斜杠,下划线,点号,字母,数字; secret时输入secret名称,configMap时输入configMap名称,emptyDir时输入disk或memory

destination

String

卷挂载路径,必须是合法的路径

read_only

Boolean

读写权限,默认读

表13 resources

名称

是否必选

参数类型

说明

limits

表14 object

允许容器使用的最大资源

requests

表14 object

容器需要使用的最小资源

表14 limits/requests

名称

是否必选

参数类型

说明

cpu

Float

cpu个数,大于0.01,最大1000,

memory

Float

内存大小,单位兆,大于0.01,最大1024000。注意:内存的limits值最小为4,

gpu

Float

Gpu显存大小,单位兆,大于0.01,小于1024000

npu

Float

Npu大小,单位兆,大于0.01,小于1024000

表15 configs

名称

是否必选

参数类型

说明

privileged

Boolean

开启容器特权模式,默认值false

host_network

Boolean

是否使用主机网络模式,默认值true

restart_policy

String

可选项:'Always', 'OnFailure', ‘Never’;默认值’Always’,’Always’表示无论容器正常或异常退出均重启容器,’OnFailure’表示只在容器异常退出时重启容器,‘Never’表示从不重启

表16 probe

名称

是否必选

参数类型

说明

exec_command

否,但必须从exec_command/http_get二者中选取一个

String

执行探测的命令行命令,长度1-10240内的字符串Exec/http_get/tcp_socket只能存在一个,长度1-10240

http_get

否,但必须从exec_command/http_get二者中选取一个

表17 object

执行http探测

initial_delay_seconds

Integer

表示从工作负载启动后从多久开始探测,大于0且不大于3600的整数,默认为10,

timeout_seconds

Integer

表示探测超时时间,大于0且不大于3600的整数,默认为1

表17 http_get

名称

是否必选

参数类型

说明

path

String

必须要以/开头,构造结果为:协议类型://主机地址:端口路径

port

Integer

探测的http端口,1到65535之间的整数

host

String

请求的主机地址,默认为容器IP

scheme

String

协议类型,HTTP或HTTPS,默认HTTP

表18 app_versions

名称

参数类型

说明

id

String

应用版本ID

description

String

应用描述

created_at

String

创建时间

updated_at

String

更新时间

project_id

String

项目ID

image_url

String

镜像存储地址

envs

Array of 表11 objects

环境变量

volumes

Array of 表12 objects

卷配置

configs

Array of 表15 object

容器特殊参数

resources

Array of 表13 objects

资源配额

arch

String

架构

command

Array of String

启动命令

args

Array of String

参数

liveness_probe

表16 object

工作负载存活探针

readiness_probe

表16 object

工作负载业务探针

表19 deployment

名称

参数类型

说明

id

String

部署ID

project_id

String

项目ID

name

String

部署名称

description

String

部署描述

created_at

String

创建时间

updated_at

String

更新时间

instances

表20 object

应用部署实例

visibility

String

可见性(预留字段)

group_id

String

应用部署所属节点组id(所属节点组的应用部署返回该字段)

group_name

String

应用部署所属节点组名称(所属节点组的应用部署返回该字段)

表20 instances

名称

参数类型

说明

name

String

应用名称

version

String

应用版本

image_url

String

镜像存储地址

envs

String

环境变量

volumes

String

卷配置

resources

Array of 表13 objects

容器使用资源配额

state

String

  • PENDING(创建中)
  • PENDING_DELETE(删除中)
  • DELETE_FAILED(删除失败)
  • RUNNING(运行中)
  • FAILED (实例异常)
  • UNKNOWN(未知)
  • FREEZE(冻结)

message

String

异常原因

node_id

String

边缘节点ID

is_ready

Boolean

指示由工作负载应用业务探针探测到的业务状态

  • UNCONFIGURE(业务探针未配置)
  • UNKNOWN(未知)
  • NORMAL(正常)
  • ABNORMAL(异常)

restarts

Integer

工作负载容器重启次数

reason

String

描述工作负载状态异常原因的简短的驼峰格式的单词

liveness_probe

表16 object

工作负载存活探针配置

readiness_probe

表16 object

工作负载业务探针配置

id

String

实例ID

command

Array of String

启动命令

args

Array of String

启动命令参数

configs

表34 object

网络参数配置

表21 twin response

名称

参数类型

说明

key

String

key最大长度128,允许英文字母、数字、下划线、中划线、点、逗号、冒号、/、@、#,key唯一

value

表22 object

边缘设备静态属性信息

表22 value in twin response

名称

参数类型

说明

excepted

表23 object

动态属性的期望信息

actual

表23 object

动态属性的实际信息

metadata

表24 object

动态属性的元数据信息

optional

Boolean

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

表23 excepted/actual

名称

参数类型

说明

value

String

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

表24 metadata

名称

参数类型

说明

timestamp

String

修改时间,UNIX timestamp格式

表25 access_config

名称

是否必选

参数类型

说明

protocol_name

value in attributes object

设备访问名称

slave_id

value in attributes object

Modbus设备访问id(0-255)

ip

value in attributes object

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

port

value in attributes object

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

serial_port

value in attributes object

RTU传输模式下串口配置

baud_rate

value in attributes object

RTU传输模式下波特率配置,value值字段可选50、75、110、150、200、300、1200、1800、2400、9600、19200、38400、57600、115200

data_bits

value in attributes object

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

stop_bits

value in attributes object

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

parity_bits

value in attributes object

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

url

value in attributes object

OPC-UA协议下访问url地址

sec_mode

value in attributes object

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

sec_policy

value in attributes object

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

auth_type

value in attributes object

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

username

value in attributes object

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

password

value in attributes object

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

private_key

value in attributes object

OPC-UA协议下,采用证书认证时私钥字段,value字段为base64格式

certificate

value in attributes object

OPC-UA协议下,采用证书认证时证书字段,value字段为base64格式

timeout

value in attributes object

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

表26 property_visitors

名称

是否必选

参数类型

说明

register_type

value in attributes object

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

access_mode

value in attributes object

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

register_index

value in attributes object

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

register_num

value in attributes object

寄存器个数

scale_index

value in attributes object

缩放因子

original_datatype

value in attributes object

原始数据类型

expected_datatype

value in attributes object

期望数据类型

is_registerswap

value in attributes object

是否交换寄存器顺序

is_swap

value in attributes object

是否交换高低字节

sample_interval

value in attributes object

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

data_min

value in attributes object

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

data_max

value in attributes object

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

node_id

value in attributes object

节点id

browse_name

value in attributes object

节点名称

表27 attributes

名称

参数类型

说明

key

String

节点属性的key值,长度取值范围为1~128, 仅允许大小写英文字母、数字、下划线、中划线

value

String

节点属性的value值,长度取值范围为1~256, 仅允许大小写英文字母、数字、下划线、中划线

表28 tags

名称

参数类型

说明

key

String

标签key值,长度取值范围为1~36, 仅允许大小写英文字母、数字、下划线、中划线

value

String

标签value值,长度取值范围为0~43, 仅允许大小写英文字母、数字、下划线、中划线

表29 nics

名称

参数类型

说明

interface

String

边缘节点网卡名称

ip

String

上述网卡对应的IPv4地址

表30 upgrade_history

名称

参数类型

说明

id

String

节点升级或安装历史版本id

from_version

String

节点升级前节点上edgecore版本号,形式如2.1.0,其中每一位都是整数

to_version

String

节点升级或安装后节点行edgecore版本号,形式如2.1.0,其中每一位都是整数

upgrade_time

String

节点升级或安装的十位时间戳

result

String

节点升级或安装状态,包含

  • install_success:边缘节点安装成功
  • upgrade_success:边缘节点升级成功
  • install_failed:边缘节点安装失败
  • upgrade_failed:边缘节点升级失败
  • upgrade_failed_rollback_success:边缘节点升级失败回滚成功
  • upgrade_failed_rollback_failed:边缘节点升级失败回滚失败

dur_time

String

节点升级所消耗的时间

表31 ntp_configs

名称

参数类型

说明

ntp_enabled

Boolean

ntp服务是否开启

ntpservers

Array of String

ntp server地址

表32 sorted

名称

参数类型

说明

key

String

按key值对请求内容进行排序

reverse

Boolean

是否采用倒序

表33 configs

名称

参数类型

说明

privileged

Boolean

默认为false,表示是否开启特权模式

host_network

Boolean

默认为true,其中true表示主机网络,而false表示端口映射

restart_policy

String

应用实例重启模式:

1. Always:当容器终止退出后,总是重启容器;

2. Onfailure:容器异常退出(退出码非0)时才重启容器;

3. Never:容器终止退出后,不重启容器;

ports

Array of 表34 objects

容器端口映射值

表34 ports

名称

参数类型

说明

container_port

Interger

构成一堆映射的容器端口

host_port

Interger

构成一对映射的物理机对应网卡端口

host_ip

String

对应网卡地址

分享:

    相关文档

    相关产品

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

提交成功!

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

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

*必选

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

字符长度不能超过200

提交反馈 取消

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

跳转到云社区