数据结构
参数 |
参数类型 |
描述 |
---|---|---|
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 |
边缘节点状态
|
package |
String |
将证书文件certificate/ca/private_key打成.tar.gz包后用base64编码的字符串。 使用时请使用base64解码成.tar.gz包。 |
master_addr |
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 |
Array of 表2 objects |
边缘节点日志配置 |
device_infos |
表3 object |
关联设备信息 |
edged_version |
String |
edged版本 |
gpu_num |
Integer |
gpu个数 |
host_ips |
Array of strings |
主机IP,默认返回eth0网卡的IP。 |
relation |
String |
与device绑定关系名称(通过device id查询node时有值) |
comment |
String |
与device绑定关系描述(通过device id查询node时有值) |
gpu_info |
表4 object |
gpu型号和gpu memory大小 |
device_num |
Integer |
关联设备数量 |
enable_npu |
Boolean |
设备是否开启NPU |
npu_type |
String |
npu类型,支持D310类型。
|
nics |
Array of 表28 object |
节点网卡和对应IP地址信息 |
host_name |
String |
边缘节点主机名 |
ief_node_version |
String |
边缘节点版本 |
product_id |
String |
产品ID(通过产品证书方式纳管) |
group_ids |
Array of String |
节点组ID(一个节点属于多个节点组) |
upgrade_history |
Array of 表29 object |
节点安装或升级记录 |
attributes |
Array of 表26 objects |
边缘节点的属性 |
docker_enable |
Boolean |
节点是否开启Docker |
mqtt_mode |
String |
mqtt集成模式
|
mqtt_external |
String |
外置开源mqtt地址 |
mqtt_internal |
String |
edgecore内置的mqtt地址 |
node_type |
String |
节点类型,默认为空,非空时为小站节点 |
ntp_configs |
表30 object |
ntp配置 |
error_reason |
String |
节点故障原因 |
tags |
Array of 表27 object |
边缘节点标签 |
npu_num |
Integer |
NPU数量 |
npu_info |
表 npu_info object |
NPU型号和NPU Memory大小 |
container_runtime_version |
String |
容器运行时版本 |
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
id |
否 |
String |
数据库保存的主键,不需要关注此字段。 |
size |
否 |
Integer |
应用日志文件大小限制,单位MB,默认50,取值范围10-1000。 |
level |
否 |
String |
|
rotate_num |
否 |
Integer |
应用日志rotate个数,默认5,取值范围1-10。 |
rotate_period |
否 |
String |
应用日志rotate周期,可选项:
|
type |
是 |
String |
|
component |
是 |
String |
|
名称 |
是否必须 |
参数类型 |
说明 |
---|---|---|---|
relation |
是 |
String |
设备和节点关系的名称,只允许中文字符、英文字母、数字、下划线、中划线,最大长度64 |
comment |
否 |
String |
设备和节点关系的描述,最大长度64,不允许^ ~ # $ % & * < > ( ) [ ] { } ' " \ |
device_ids |
是 |
Array of strings |
设备ID列表 |
名称 |
参数类型 |
说明 |
---|---|---|
id |
String |
终端设备ID |
name |
String |
终端设备名称 |
description |
String |
终端设备描述 |
state |
String |
终端设备的状态,默认为unknown |
last_online |
String |
终端设备最后活跃时间 |
project_id |
String |
项目ID |
attributes |
表6 object |
静态属性信息 |
created_at |
String |
创建时间 |
updated_at |
String |
更新时间 |
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
value |
是 |
String |
value最大长度512,value允许英文字母、数字、下划线、中划线、点、逗号、@、#、+、\、/、?、^、=、%、&、:、~ |
optional |
否 |
Boolean |
标识属性是否可选,默认为true |
metadata |
否 |
表9 object |
静态属性的元数据信息,默认为{"type": "string"} |
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
excepted |
是 |
表8 object |
动态属性的期望信息 |
optional |
否 |
Boolean |
标识属性是否可选,默认为true,继承模板的属性默认为false |
metadata |
否 |
表9 object |
静态属性的元数据信息,默认为{“type”:”string”} |
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
value |
是 |
String |
动态属性的初始值,最大长度512, value允许英文字母、数字、下划线、中划线、点、逗号、冒号、/、@、# |
metadata |
否 |
表23 object |
期望值设置的时间信息 |
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
type |
是 |
String |
属性类型标识,string|int|float|boolean(boolean类型为true或false),默认为string |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
环境变量的key,由大小写字母或下划线开头,由数字、大小写字母、下划线组成,最大长度2048个字符,不允许重复 |
value |
否 |
String |
环境变量的value,最大长度20480个字符。value、value_from和field_path必须三选一使用。 |
value_from |
否 |
表35 object |
环境变量可使用配置项和密钥导入 |
field_path |
否 |
String |
该参数目前只支持赋值“status.hostIP”,即引用边缘节点的IP地址作为环境变量。 |
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
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 |
读写权限,configMap和secret类型只支持读权限 |
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
cpu |
否 |
String |
cpu核数,大于等于0.01,最大1000;请求不需要带单位 |
memory |
否 |
String |
内存大小,单位兆,大于等于0.01,最大1024000。注意:内存的limits值最小为4;请求不需要带单位 |
gpu |
否 |
String |
Gpu显存大小,单位兆,大于等于0.01,最大1024000;请求不需要带单位 |
npu |
否 |
String |
Npu个数,大于0,最大1000;请求不需要带单位 |
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
privileged |
否 |
Boolean |
开启容器特权模式,默认值false |
host_network |
否 |
Boolean |
是否使用主机网络模式,默认值true,false时表示端口映射网络模式 |
restart_policy |
否 |
String |
可选项:Always、OnFailure、Never;默认值Always。 Always表示无论容器正常或异常退出均重启容器;OnFailure表示只在容器异常退出时重启容器;Never表示从不重启 |
ports |
否 |
Array of 表34 object |
容器端口映射值,当开启端口映射网络模式时此处必填 |
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
exec_command |
是 |
String |
(exec_command和http_get二选一) 执行探测的命令行命令,长度1-10240内的字符串 |
http_get |
是 |
表16 object |
(exec_command和http_get二选一) 执行http探测 |
initial_delay_seconds |
否 |
Integer |
表示从工作负载启动后从多久开始探测,大于0且不大于3600的整数,默认为10。 |
timeout_seconds |
否 |
Integer |
表示探测超时时间,大于0且不大于3600的整数,默认为1。 |
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
path |
是 |
String |
必须要以/开头,构造结果为:协议类型://主机地址:端口路径 |
port |
是 |
Integer |
探测的http端口,1到65535之间的整数 |
host |
否 |
String |
请求的主机地址,默认为容器IP |
scheme |
否 |
String |
协议类型,HTTP或HTTPS,默认HTTP |
名称 |
参数类型 |
说明 |
---|---|---|
id |
String |
应用版本ID |
version |
String |
应用版本号 |
created_at |
String |
创建时间 |
updated_at |
String |
更新时间 只有更新后才会出现该字段 |
project_id |
String |
项目ID |
image_url |
String |
镜像存储地址 |
envs |
Array of 表10 objects |
环境变量 |
volumes |
Array of 表11 objects |
卷配置 |
configs |
表32 object |
容器特殊参数 |
resources |
表12 object |
资源配额 |
arch |
String |
架构 |
command |
Array of String |
启动命令 |
args |
Array of String |
参数 |
liveness_probe |
表15 object |
工作负载存活探针 |
readiness_probe |
表15 object |
工作负载业务探针 |
名称 |
参数类型 |
说明 |
---|---|---|
id |
String |
部署ID |
project_id |
String |
项目ID |
name |
String |
部署名称 |
description |
String |
部署描述 |
created_at |
String |
创建时间 |
updated_at |
String |
更新时间 |
instances |
表19 object |
应用部署实例 |
visibility |
String |
可见性(预留字段) |
group_id |
String |
应用部署所属节点组id(所属节点组的应用部署返回该字段) |
group_name |
String |
应用部署所属节点组名称(所属节点组的应用部署返回该字段) |
ready_replicas |
Integer |
状态为ready的副本数量 |
replicas |
Integer |
副本数量 |
名称 |
参数类型 |
说明 |
---|---|---|
name |
String |
名称(预埋字段) |
version |
String |
应用版本 |
image_url |
String |
镜像存储地址 |
envs |
String |
环境变量 |
volumes |
String |
卷配置 |
resources |
Array of 表12 objects |
容器使用资源配额 |
state |
String |
|
message |
String |
异常原因 |
node_id |
String |
边缘节点ID |
is_ready |
String |
指示由工作负载应用业务探针探测到的业务状态
|
restarts |
Integer |
工作负载容器重启次数 |
reason |
String |
描述工作负载状态异常原因的简短的驼峰格式的单词 |
liveness_probe |
表15 object |
工作负载存活探针配置 |
readiness_probe |
表15 object |
工作负载业务探针配置 |
id |
String |
实例ID |
command |
Array of String |
启动命令 |
args |
Array of String |
启动命令参数 |
configs |
表32 object |
网络参数配置 |
名称 |
参数类型 |
说明 |
---|---|---|
key |
String |
key最大长度128,允许英文字母、数字、下划线、中划线、点、逗号、冒号、/、@、#,key唯一 |
value |
表21 object |
终端设备静态属性信息 |
名称 |
参数类型 |
说明 |
---|---|---|
excepted |
表22 object |
动态属性的期望信息 |
actual |
表22 object |
动态属性的实际信息 |
metadata |
表23 object |
时间信息 |
optional |
Boolean |
标识属性是否可选,默认为true,继承模板的属性默认为false |
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
protocol_type |
是 |
value in attributes object |
设备访问类型,包含:
|
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 |
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
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 |
节点名称 |
名称 |
参数类型 |
说明 |
---|---|---|
key |
String |
节点属性的key值,长度取值范围为1~128, 仅允许大小写英文字母、数字、下划线、中划线 |
value |
String |
节点属性的value值,长度取值范围为1~256, 仅允许大小写英文字母、数字、下划线、中划线 |
名称 |
参数类型 |
说明 |
---|---|---|
key |
String |
标签key值,长度取值范围为1~36, 仅允许大小写英文字母、数字、下划线、中划线 |
value |
String |
标签value值,长度取值范围为1~43, 仅允许大小写英文字母、数字、下划线、中划线 |
名称 |
参数类型 |
说明 |
---|---|---|
id |
Integer |
节点升级或安装历史版本id |
from_version |
String |
节点升级前节点上edgecore版本号,形式如2.1.0,其中每一位都是整数 |
to_version |
String |
节点升级或安装后节点行edgecore版本号,形式如2.1.0,其中每一位都是整数 |
upgrade_time |
Integer |
节点升级或安装的十位时间戳 |
result |
String |
节点升级或安装状态,包含
|
dur_time |
Integer |
节点升级所消耗的时间 |
名称 |
参数类型 |
说明 |
---|---|---|
privileged |
Boolean |
默认为false,表示是否开启特权模式 |
host_network |
Boolean |
默认为true,其中true表示主机网络,而false表示端口映射 |
restart_policy |
String |
应用实例重启模式:
|
ports |
Array of 表33 objects |
容器端口映射值 |
名称 |
参数类型 |
说明 |
---|---|---|
container_port |
Integer |
构成一堆映射的容器端口 |
host_port |
Integer |
构成一对映射的物理机对应网卡端口 |
host_ip |
String |
对应网卡地址 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
secret |
否 |
表36 object |
环境变量引用密钥时使用。使用ValueFrom时,secret与configmap必须二选一。 |
configmap |
否 |
表37 object |
环境变量引用配置项时使用。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enable_mqtt |
是 |
Boolean |
是否启用MQTT |
mqtts |
是 |
Array of 表39 objects |
MQTT配置 当enable_mqtt取值为false时,mqtts需要为空数组。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
bind_addr |
是 |
String |
MQTT监听地址,根据type取值确定。 |
port |
是 |
Integer |
端口号 |
type |
是 |
String |
类型 枚举值:
|
名称 |
参数类型 |
说明 |
---|---|---|
name |
String |
NPU名称 |
type |
String |
NPU类型 |
capacity |
String |
NPU memory大小 |
driver_version |
String |
NPU驱动版本 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
nodeAffinity |
否 |
nodeAffinity object |
节点亲和规则 |
podAffinity |
否 |
podAffinity object |
Pod亲和规则 |
podAntiAffinity |
否 |
podAffinity object |
Pod反亲和规则 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
preferredDuringSchedulingIgnoredDuringExecution |
否 |
Array of preferredSchedulingTerm object |
优先使用定义的规则调度,且不会影响已经在节点上运行的Pod。即优先选择调度到满足规则的节点,但也可能会调度到不满足规则的节点。 |
requiredDuringSchedulingIgnoredDuringExecution |
否 |
强制使用定义的规则调度,且不会影响已经在节点上运行的Pod。即强制选择调度到满足规则的节点,不会调度到不满足规则的节点。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
preferredDuringSchedulingIgnoredDuringExecution |
否 |
Array of weightPodAffinityTerms object |
优先使用定义的规则调度,且不会影响已经在节点上运行的Pod。即优先选择调度到满足规则的节点,但也可能会调度到不满足规则的节点。 |
requiredDuringSchedulingIgnoredDuringExecution |
否 |
Array of podAffinityTerm object |
强制使用定义的规则调度,且不会影响已经在节点上运行的Pod。即强制选择调度到满足规则的节点,不会调度到不满足规则的节点。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
preference |
否 |
matchExpressions object |
与相应权重关联的节点选择器项。 |
weight |
否 |
Integer |
权重,范围为1-100 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
nodeSelectorTerms |
否 |
Array of matchExpressions object |
节点选择规则 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
matchExpressions |
否 |
Array of matchExpressions object |
匹配规则表达式 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
key |
否 |
String |
规则的标签 |
operator |
否 |
String |
操作符,取值如下:
|
values |
否 |
Array of String |
一组标签值。
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
podAffinityTerm |
否 |
podAffinityTerm object |
Pod亲和规则 |
weight |
否 |
Integer |
权重,范围为1-100 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
labelSelector |
否 |
labelSelector object |
标签选择器 |
namespaces |
否 |
Array of strings |
命名空间 |
topologyKey |
否 |
String |
拓扑标签。 先圈定topologyKey指定的范围,然后再选择labelSelector定义的内容,即亲和调度只会在有topologyKey指定的标签节点上调度。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
matchExpressions |
否 |
Array of matchExpression object |
匹配规则表达式 |
matchLabels |
否 |
Map<String, String> |
匹配的标签,格式为key:value键值对。 单个键值对相当于matchExpressions的一个元素,key字段为key,操作符为In,values数组中只有value。 |