有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

ApplicationBasicConfig

应用基本配置

被如下接口引用:CreateApplicationVisualization, CreateEdgeUnitApplicationVisualization, DescribeApplicationVisualization, DescribeEdgeUnitApplicationVisualization, ModifyApplicationVisualization, ModifyEdgeUnitApplicationVisualization。

名称 类型 必选 描述
Name String 名称
Namespace String 命名空间
WorkflowKind String 工作负载类型
示例值:Deployment
Labels Array of Label 标签信息
GridUniqKey String Grid唯一Key
示例值:default-group
NodeSelector Array of Label NodeSelector标签
Replicas Integer 实例数
AvailableReplicas Integer 可用实例数
EnableServiceLinks Boolean 是否开启service环境变量注入pod
注意:此字段可能返回 null,表示取不到有效值。

ApplicationBasicInfo

应用基本信息

被如下接口引用:CreateApplicationVisualization, CreateEdgeUnitApplicationVisualization, CreateEdgeUnitApplicationYaml, DescribeApplicationVisualization, DescribeEdgeUnitApplicationVisualization, ModifyApplicationBasicInfo, ModifyEdgeUnitApplicationBasicInfo。

名称 类型 必选 描述
Name String 名称
ManageUrl String 管理URL地址
Description String 描述信息
CreateTime String 创建时间
AllowVisualModify Boolean 是否允许可视化修改
注意:此字段可能返回 null,表示取不到有效值。
示例值:false

ApplicationDeployMode

应用部署模式

被如下接口引用:DescribeEdgeUnitApplications。

名称 类型 描述
Type Integer 1:指定节点部署 2:单元部署
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ResourceID Integer 资源ID
示例值:1
ResourceName String 资源名

ApplicationStatusInfo

应用状态

被如下接口引用:DescribeEdgeUnitApplications。

名称 类型 描述
Id Integer 应用ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Name String 应用名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:app
Version String 应用版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:1.0
Status String 应用状态(1:待部署 2:部署中 3:运行中 4:待更新 5:更新中 6:待删除 7:删除中 8:已删除
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
StartTime String 开始时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2012-01-01 00:00:00
ManageUrl String 管理地址
注意:此字段可能返回 null,表示取不到有效值。
WorkloadKind String 负载类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:Deployment
DeployMode ApplicationDeployMode 应用部署模式
注意:此字段可能返回 null,表示取不到有效值。
Replicas Integer 期望Pod数
注意:此字段可能返回 null,表示取不到有效值。
AvailableReplicas Integer 运行Pod数
注意:此字段可能返回 null,表示取不到有效值。

ApplicationTemplate

应用模板列表详情

被如下接口引用:DescribeApplications。

名称 类型 描述
Id Integer 模板ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:"222"
Name String 模板名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:name
Source Integer 来源。1 自定义应用模板 ; 2 官方应用模板
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
WorkloadKind String 应用类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:v1
ManageUrl String 管理地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:http://xxxx
DistributeTime String 发布时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxxx

ConfigMapBasicInfo

ConfigMap基本信息

被如下接口引用:DescribeConfigMaps。

名称 类型 描述
Name String 名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:iecp
Namespace String 命名空间
注意:此字段可能返回 null,表示取不到有效值。
示例值:default
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2012-01-01 00:00:00

Container

容器配置信息

被如下接口引用:CreateApplicationVisualization, CreateEdgeUnitApplicationVisualization, DescribeApplicationVisualization, DescribeEdgeUnitApplicationVisualization, ModifyApplicationVisualization, ModifyEdgeUnitApplicationVisualization。

名称 类型 必选 描述
Name String 名称
示例值:test
ImageName String 镜像名
示例值:nginx
ImageVersion String 镜像版本
示例值:v1.0
ImagePullPolicy String 镜像拉取策略(Always|Never|IfNotPresent)
示例值:Always
VolumeMounts Array of VolumeMount 卷挂载配置
注意:此字段可能返回 null,表示取不到有效值。
CpuRequest String cpu最低配置
示例值:200m
CpuLimit String cpu最高限制
示例值:200m
MemoryRequest String 内存最低要求
示例值:200
MemoryLimit String 内存最高要求
示例值:300
MemoryUnit String 内存单位
示例值:MB
GpuLimit String gpu最高限制
示例值:200m
ResourceMapCloud Array of KeyValueObj 资源配置
Envs Array of Env 环境配置
WorkingDir String 工作目录
示例值:/root
Commands Array of String 命令
Args Array of String 参数
SecurityContext SecurityContext 安全配置
ReadinessProbe Probe 就绪探针配置

ContainerStatus

容器状态

被如下接口引用:DescribeEdgeUnitApplicationPodContainers。

名称 类型 描述
Name String 容器名
注意:此字段可能返回 null,表示取不到有效值。
示例值:Container-Name
ID String 容器ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:Container-ID
Image String 镜像
注意:此字段可能返回 null,表示取不到有效值。
示例值:nginx:latest
RestartCount Integer 重启次数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Status String 状态
示例值:running

CronJob

CronJob配置

被如下接口引用:CreateApplicationVisualization, CreateEdgeUnitApplicationVisualization, DescribeApplicationVisualization, DescribeEdgeUnitApplicationVisualization, ModifyApplicationVisualization, ModifyEdgeUnitApplicationVisualization。

名称 类型 必选 描述
Schedule String 调度配置
StartingDeadlineSeconds Integer 运行时间
示例值:1
ConcurrencyPolicy String job并行策略(Allow|Forbid|Replace)
示例值:Allow
Job Job Job配置

DeleteEdgeUnitDevicesDevice

从单元批量解绑设备

被如下接口引用:DeleteEdgeUnitDevices。

名称 类型 必选 描述
ProductId String
DeviceName String

DockerConfig

docker配置

被如下接口引用:CreateSecret。

名称 类型 必选 描述
RegistryDomain String 镜像仓库地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:test.com
UserName String 用户名
Password String 密码

DracoNodeInfo

Draco 设备预录入信息

被如下接口引用:CreateEdgeNodeBatch, ModifyEdgeDracoNode。

名称 类型 必选 描述
SN String 设备SN。SN仅支持大写字母、数字,长度限制为1~32个字符
示例值:121212
Name String 节点名称。长度限制为1~63个字符,节点名称只支持小写英文、数字、中横线、英文句号
示例值:sssss
Remark String 节点备注
示例值:ddd

EdgeCloudCluster

获取边缘集群列表

被如下接口引用:DescribeEdgeUnitsCloud。

名称 类型 描述
EdgeId Integer IECP侧边缘集群ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:10322
ClusterId String 边缘集群ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:cls-xxxx
Region String 区域
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-xxx
ClusterName String 集群名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxxx
K8SVersion String 集群版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:1.x.x
VpcId String 私有网络ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:vpc-xxx
ClusterDesc String 描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx
Status String 集群状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxxxx
PodCIDR String pod cidr
注意:此字段可能返回 null,表示取不到有效值。
示例值:10.0.0.0/16
ServiceCIDR String service cidr
注意:此字段可能返回 null,表示取不到有效值。
示例值:10.1.0.0/16
EdgeClusterVersion String 边缘版本类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:2.2
UID String 用户ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:123

EdgeDracoNodeInfo

预注册节点的信息

被如下接口引用:DescribeEdgeSnNodes。

名称 类型 描述
Id Integer 节点ID
示例值:2222
Name String 节点名称
示例值:sss
IsUsed Boolean 是否已激活
示例值:false
CreateTime String 创建时间
示例值:xxxx
Remark String 备注信息,如批次
示例值:sss
SN String SN 设备号
示例值:sss

EdgeNodeInfo

边缘节点信息

被如下接口引用:DescribeEdgeNodes。

名称 类型 描述
Id Integer IECP边缘节点ID
示例值:1
Name String 节点名称
示例值:testnode
Status Integer 节点状态 (1健康|2异常|3离线|4未激活)
示例值:1
CreateTime String 创建时间
示例值:2021-01-01 00:00:00
Resource EdgeNodeResourceInfo 节点资源信息
注意:此字段可能返回 null,表示取不到有效值。
CpuArchitecture String CPU体系结构
注意:此字段可能返回 null,表示取不到有效值。
示例值:amd64
Ip String IP地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:0.0.0.0
OperatingSystem String 操作系统
注意:此字段可能返回 null,表示取不到有效值。
示例值:CentOS Linux 7 (Core)
NodeUnits KeyValueObj 节点所属的NodeUnit
key:NodeUnit模版ID,Value:NodeUnit模版名称
注意:此字段可能返回 null,表示取不到有效值。

EdgeNodeInstallerOnline

节点在线安装信息

被如下接口引用:DescribeEdgeAgentNodeInstaller。

名称 类型 描述
ScriptName String 节点安装脚本名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:edgectl
ScriptDownloadUrl String 节点安装脚本下载链接
注意:此字段可能返回 null,表示取不到有效值。
Guide String 节点安装命令
注意:此字段可能返回 null,表示取不到有效值。

EdgeNodeLabel

边缘节点标签

被如下接口引用:DescribeEdgeNode。

名称 类型 描述
Key String 标签名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:kubernetes.io/hostname
Value String 标签值
注意:此字段可能返回 null,表示取不到有效值。
示例值:testnode
Protected Boolean 是否受保护
示例值:true

EdgeNodePodContainerInfo

边缘节点Pod容器信息

被如下接口引用:DescribeEdgeNodePodContainers。

名称 类型 描述
Name String Pod名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:aa-aaa
Id String 容器ID
注意:此字段可能返回 null,表示取不到有效值。
Image String 镜像(含版本号)
注意:此字段可能返回 null,表示取不到有效值。
示例值:amd64-latest
CpuRequest String CPU Request
注意:此字段可能返回 null,表示取不到有效值。
示例值:250m
CpuLimit String CPU Limit
注意:此字段可能返回 null,表示取不到有效值。
示例值:500m
MemoryRequest String Memory Request
注意:此字段可能返回 null,表示取不到有效值。
示例值:256Mi
MemoryLimit String Memory Limit
注意:此字段可能返回 null,表示取不到有效值。
示例值:1Gi
RestartCount Integer 重启次数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Status String 容器状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:Running

EdgeNodePodInfo

边缘节点Pod信息

被如下接口引用:DescribeEdgeNodePods, DescribeEdgePod。

名称 类型 描述
Name String Pod名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:aa-aaa
Status String Pod状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:Running
NodeIp String 所在节点IP
注意:此字段可能返回 null,表示取不到有效值。
示例值:10.0.0.0
Ip String 实例IP
注意:此字段可能返回 null,表示取不到有效值。
示例值:10.0.0.0
CpuRequest String CPU Request
注意:此字段可能返回 null,表示取不到有效值。
示例值:250m
MemoryRequest String Memory Request
注意:此字段可能返回 null,表示取不到有效值。
示例值:256Mi
Namespace String 命名空间
注意:此字段可能返回 null,表示取不到有效值。
示例值:default
WorkloadType String 工作负载类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:Deployment
WorkloadName String 工作负载名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:aaa
StartTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2020-01-01 00:00:00
RestartCount Integer 重启次数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ClusterID String 集群ID
示例值:cls-vsd4advw

EdgeNodeResourceInfo

边缘节点资源信息

被如下接口引用:DescribeEdgeNode, DescribeEdgeNodes。

名称 类型 描述
AllocatedCPU String 可使用的CPU 单位: m核
注意:此字段可能返回 null,表示取不到有效值。
示例值:120m
TotalCPU String CPU总量 单位:m核
注意:此字段可能返回 null,表示取不到有效值。
示例值:4000m
AllocatedMemory String 已分配的内存 单位G
注意:此字段可能返回 null,表示取不到有效值。
示例值:0.15
TotalMemory String 内存总量 单位G
注意:此字段可能返回 null,表示取不到有效值。
示例值:7.64
AllocatedGPU String 已分配的GPU资源
注意:此字段可能返回 null,表示取不到有效值。
TotalGPU String GPU总量
注意:此字段可能返回 null,表示取不到有效值。
AvailableCPU String 可使用的CPU 单位: m核
注意:此字段可能返回 null,表示取不到有效值。
AvailableMemory String 可使用的内存 单位: G
注意:此字段可能返回 null,表示取不到有效值。
示例值:6.42
AvailableGPU String 可使用的GPU资源
注意:此字段可能返回 null,表示取不到有效值。
示例值:0

EdgeUnitStatisticItem

单元内的统计信息

被如下接口引用:DescribeEdgeUnitCloud。

名称 类型 描述
Total Integer 总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Online Integer 在线数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Abnormal Integer 异常数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Offline Integer 离线数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
NotActive Integer 未激活
注意:此字段可能返回 null,表示取不到有效值。
示例值:0

Env

环境变量

被如下接口引用:CreateApplicationVisualization, CreateEdgeUnitApplicationVisualization, DescribeApplicationVisualization, DescribeEdgeUnitApplicationVisualization, ModifyApplicationVisualization, ModifyEdgeUnitApplicationVisualization。

名称 类型 必选 描述
Name String 名称
Value String
ValueFrom EnvValueSelector 值引用

EnvValueSelector

环境变量选择

被如下接口引用:CreateApplicationVisualization, CreateEdgeUnitApplicationVisualization, DescribeApplicationVisualization, DescribeEdgeUnitApplicationVisualization, ModifyApplicationVisualization, ModifyEdgeUnitApplicationVisualization。

名称 类型 必选 描述
Key String 健名
ObjectName String 对象名
ObjectType String 对象值

Event

事件信息

被如下接口引用:DescribeEdgeUnitApplicationEvents。

名称 类型 描述
FirstTime String 第一次出现时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2012-01-01 00:00:00
LastTime String 最后一次出现时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2012-01-01 00:00:00
InvolvedObjectKind String 事件关联对象类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:Deployment
InvolvedObjectName String 事件关联对象名
注意:此字段可能返回 null,表示取不到有效值。
示例值:app
Type String 事件类型(Normal|Warning)
示例值:Normal
Reason String 原因
注意:此字段可能返回 null,表示取不到有效值。
Message String 内容
注意:此字段可能返回 null,表示取不到有效值。
Count Integer 出现次数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

FieldSort

字段排序

被如下接口引用:DescribeApplications, DescribeConfigMaps, DescribeEdgeOperationLogs, DescribeEdgeUnitApplications, DescribeSecrets。

名称 类型 必选 描述
Field String 字段名
Order String 排序(ASC:升序 DESC:降序

GridDetail

ServiceGroup中Grid信息

被如下接口引用:DescribeEdgeUnitNodeGroup。

名称 类型 描述
Name String Grid名称
示例值:abc
Id Integer GridID
示例值:1

GridEventInfo

Grid事件信息

被如下接口引用:DescribeEdgeUnitGridEvents。

名称 类型 描述
FirstTime String 首次出现时间
示例值:2021-08-11 21:41:52
LastTime String 最后出现时间
示例值:2021-08-11 21:41:52
InvolvedObjectKind String 对象类型
示例值:Pod
InvolvedObjectName String 对象名称
示例值:a-grid-b
Type String 事件类型(Normal,Warning)
示例值:Normal
Reason String 事件原因
示例值:Pulling
Message String 事件内容
示例值:Puling image xx
Count Integer 次数
示例值:100
NodeName String 节点名(Pod事件类型时有值)
示例值:node-1
IP String 节点内部IP(Pod事件类型时有值)
注意:此字段可能返回 null,表示取不到有效值。
示例值:10.0.0.1

GridInfo

Grid信息

被如下接口引用:DescribeEdgeUnitDeployGrid。

名称 类型 描述
Id Integer DeployGridId
示例值:1
Name String 名称
示例值:a
GridUniqKey String Key
示例值:a-group
Description String 描述
示例值:Description
WorkloadKind String 工作负载类型
示例值:DeploymentGrid
StartTime String 启动时间
示例值:2021-07-20 11:30:42
Replicas Integer 副本数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Publisher String 创建人
示例值:123
Version String 版本信息
示例值:v1

GridItemInfo

Grid部署应用信息

被如下接口引用:DescribeEdgeUnitDeployGridItem。

名称 类型 描述
Name String 名称
示例值:a
Replicas Integer 期望副本数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
AvailableReplicas Integer 可用副本数
示例值:1
StartTime String 启动时间
示例值:2021-07-06 10:43:00
WorkloadKind String 工作负载类型
示例值:Deployment

GridPodInfo

GridPod信息

被如下接口引用:DescribeEdgeUnitGridPods。

名称 类型 描述
Name String Pod名称
示例值:a
NameSpace String 命名空间
示例值:default
Status String 状态(Pending|Running|Succeeded|Failed|Unknown)
示例值:Pending
NodeName String 节点名
示例值:node1
NodeIP String 节点IP
示例值:10.0.0.1
PodIP String Pod的IP
示例值:10.0.0.1
StartTime String 启动时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-08-23 16:49:18
RunSec Integer 运行时长(秒)
注意:此字段可能返回 null,表示取不到有效值。
示例值:100
RestartCount Integer 重启次数
示例值:1
ClusterID String 集群名称ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:cls-xxxx

HorizontalPodAutoscaler

pod水平伸缩配置

被如下接口引用:CreateApplicationVisualization, CreateEdgeUnitApplicationVisualization, DescribeApplicationVisualization, DescribeEdgeUnitApplicationVisualization, ModifyApplicationVisualization, ModifyEdgeUnitApplicationVisualization。

名称 类型 必选 描述
Name String 名称
示例值:test
Namespace String 命名空间
示例值:default
MinReplicas Integer 最小实例数
示例值:1
MaxReplicas Integer 最大实例数
示例值:1
ResourceMetricTarget Array of ResourceMetricTarget 资源目标指标

HttpHeader

Http探测头

被如下接口引用:CreateApplicationVisualization, CreateEdgeUnitApplicationVisualization, DescribeApplicationVisualization, DescribeEdgeUnitApplicationVisualization, ModifyApplicationVisualization, ModifyEdgeUnitApplicationVisualization。

名称 类型 必选 描述
Name String HTTP头的名称
注意:此字段可能返回 null,表示取不到有效值。
Value String HTTP头的值
注意:此字段可能返回 null,表示取不到有效值。

HttpProbe

HTTP探测配置

被如下接口引用:CreateApplicationVisualization, CreateEdgeUnitApplicationVisualization, DescribeApplicationVisualization, DescribeEdgeUnitApplicationVisualization, ModifyApplicationVisualization, ModifyEdgeUnitApplicationVisualization。

名称 类型 必选 描述
Path String 请求路径
注意:此字段可能返回 null,表示取不到有效值。
Port Integer 请求端口
注意:此字段可能返回 null,表示取不到有效值。
示例值:80
Host String 请求地址,默认Pod的IP
注意:此字段可能返回 null,表示取不到有效值。
Scheme String 请求模式 HTTP|HTTPS,默认HTTP
注意:此字段可能返回 null,表示取不到有效值。
Headers Array of HttpHeader HTTP的请求头
注意:此字段可能返回 null,表示取不到有效值。

IotDevicesInfo

子设备列表信息

被如下接口引用:DescribeIotDevices。

名称 类型 描述
Id Integer 设备id
示例值:100010
Name String 设备名称
示例值:xxx
Status Integer 设备状态
示例值:1
Disabled Boolean 设备打开状态
示例值:true
Description String 描述
示例值:xxx
CreateTime String 设备创建时间
示例值:2021-12-01
LastOnlineTime String 最后在线时间
示例值:2021-12-01
IsBound Boolean 设备是否绑定到节点
示例值:true
Version String 设备版本
示例值:1.0.1
Region String
UnitID Integer
UnitName String

Job

Job配置

被如下接口引用:CreateApplicationVisualization, CreateEdgeUnitApplicationVisualization, DescribeApplicationVisualization, DescribeEdgeUnitApplicationVisualization, ModifyApplicationVisualization, ModifyEdgeUnitApplicationVisualization。

名称 类型 必选 描述
Parallelism Integer 并发数
示例值:1
Completion Integer 完成数
示例值:1
ActiveDeadlineSeconds Integer 最大运行时间
示例值:1
BackOffLimit Integer 失败前重试次数
示例值:1

KeyValueObj

KeyValue对象

被如下接口引用:CreateApplicationVisualization, CreateConfigMap, CreateEdgeUnitApplicationVisualization, CreateSecret, DescribeApplicationVisualization, DescribeEdgeNodes, DescribeEdgeUnitApplicationVisualization, ModifyApplicationVisualization, ModifyEdgeNodeLabels, ModifyEdgeUnitApplicationVisualization。

名称 类型 必选 描述
Key String Key值
示例值:Key
Value String Value值
示例值:Value

Label

标签信息

被如下接口引用:CreateApplicationVisualization, CreateEdgeUnitApplicationVisualization, DescribeApplicationVisualization, DescribeEdgeUnitApplicationVisualization, ModifyApplicationVisualization, ModifyEdgeUnitApplicationVisualization。

名称 类型 必选 描述
Key String 健名
示例值:key
Value String 健值
示例值:value

MarketComponentInfo

组件市场的组件描述

被如下接口引用:GetMarketComponentList。

名称 类型 必选 描述
ID Integer 组件ID
示例值:1
AppName String 组件名称
示例值:test
Author String 发布者
示例值:qcloud
ReleaseTime String 发布时间
示例值:2021-3-12
Outline String 组件简介
示例值:xxx
Detail String 指向详细描述的url
示例值:xxx
Icon String 图标链接
示例值:http://xxx/xx.png
Version String 组件版本
示例值:1.1.0
WorkloadVisualConfig String 组件可视化信息
示例值:xxx
DetailUrl String
Installed Boolean

MonitorMetricsColumn

监控数据列

被如下接口引用:DescribeMonitorMetrics。

名称 类型 描述
ColumnName String 数据名称
示例值:nod_pod_num
ColumnData Array of String 数据内容
注意:此字段可能返回 null,表示取不到有效值。
示例值:['7','8','9']
ColumnBelong String 数据所属,查询Workload类型时有值
示例值:node123
MaxValue Float 最大值
示例值:9
MinValue Float 最小值
示例值:7
AvgValue Float 平均值
示例值:8
ColumnTime Integer 时间戳数组
注意:此字段可能返回 null,表示取不到有效值。

NamespaceInfo

命名空间信息

被如下接口引用:DescribeNamespaces。

名称 类型 描述
Namespace String 命名空间名
注意:此字段可能返回 null,表示取不到有效值。
示例值:default
Status String 状态(Active|Terminating)
注意:此字段可能返回 null,表示取不到有效值。
示例值:Active
Description String 描述信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:descript
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-01-01 00:00:00
Protected Boolean 是否保护(不允许删除)
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
Yaml String 对应的Yaml配置
注意:此字段可能返回 null,表示取不到有效值。

NamespaceResource

命名空间下资源描述

被如下接口引用:DescribeNamespaceResources。

名称 类型 描述
Type String 类型(workload|grid|configmap|secret)
注意:此字段可能返回 null,表示取不到有效值。
示例值:workload
Count Integer 总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Names Array of String 名称(最多返回5个)
注意:此字段可能返回 null,表示取不到有效值。

NodeGroupInfo

NodeGroup信息

被如下接口引用:DescribeEdgeUnitNodeGroup。

名称 类型 描述
Description String 描述
示例值:abc
CreateTime String 创建时间
示例值:2006-01-02 15:04:05
NodeGroupName String NodeGroup名称
示例值:abc
DeploymentGridList Array of GridDetail DeploymentGrid数组
注意:此字段可能返回 null,表示取不到有效值。
StatefulSetGridList Array of GridDetail StatefulSetGrid数组
注意:此字段可能返回 null,表示取不到有效值。
Protect Boolean 是否平台保护
注意:此字段可能返回 null,表示取不到有效值。
示例值:false

NodeGroupNodeUnitTemplateInfo

指定NodeGroup中查询NodeUnit模版

被如下接口引用:DescribeNodeUnitTemplateOnNodeGroup。

名称 类型 描述
ID Integer 模版ID
示例值:1
Name String 名称
示例值:abc
Namespace String 命名空间
示例值:default
Description String 描述
示例值:Description
NodeList Array of NodeSimpleInfo 包含节点列表
UpdateTime String 更新时间
示例值:2021-08-23 16:49:18
CreateTime String 创建时间
示例值:2021-08-23 16:49:18
Relation Boolean 是否关联
示例值:true

NodeSimpleInfo

节点基础信息

被如下接口引用:DescribeEdgeUnitNodeUnitTemplates, DescribeNodeUnitTemplateOnNodeGroup。

名称 类型 描述
ID Integer 节点ID
示例值:1
NodeName String 节点名称
示例值:node-123

NodeUnitInfo

NodeUnit信息

被如下接口引用:DescribeNodeUnit。

名称 类型 描述
Id Integer NodeUnitId
示例值:1
NodeUnitName String NodeUnit名称
示例值:abc
NodeList Array of NodeUnitNodeInfo 包含节点列表
注意:此字段可能返回 null,表示取不到有效值。

NodeUnitNodeInfo

NodeUnit中边缘节点信息

被如下接口引用:DescribeNodeUnit。

名称 类型 描述
Id Integer 节点ID
示例值:1
Status String 节点状态 NodeStatusHealthy (健康)/NodeStatusAbnormal (异常)/NodeStatusOffline (下线)/NodeStatusNotActivated (未激活
示例值:NodeStatusHealthy
NodeName String 节点名称
示例值:node-123
InternalIP String 内网节点IP
示例值:10.0.0.1

NodeUnitTemplate

NodeUnit模版信息

被如下接口引用:DescribeEdgeUnitNodeUnitTemplates。

名称 类型 描述
ID Integer NodeUnit模版ID
示例值:1
Name String NodeUnit模版名称
示例值:abc
Namespace String 命名空间
示例值:default
Description String 描述
示例值:Description
NodeList Array of NodeSimpleInfo 包含节点列表
注意:此字段可能返回 null,表示取不到有效值。
NodeGroups Array of String NodeGroup列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:["node-group-1"]
UpdateTime String 更新时间
示例值:2021-08-11 08:52:40
CreateTime String 创建时间
示例值:2021-08-11 08:52:40

OperationLog

操作日志

被如下接口引用:DescribeEdgeOperationLogs。

名称 类型 描述
OperateTime String 操作时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2012-01-01 00:00:00
Module String 模块名
注意:此字段可能返回 null,表示取不到有效值。
示例值:edgeunit
Description String 操作信息
UserId String 用户ID
Status Integer 状态: 1:成功 2:失败
示例值:1
OperatorUserID String 操作用户ID
注意:此字段可能返回 null,表示取不到有效值。
Action String 操作动作
注意:此字段可能返回 null,表示取不到有效值。

OperationLogsCondition

操作日志状态查询条件

被如下接口引用:DescribeEdgeOperationLogs。

名称 类型 必选 描述
Status Array of Integer 状态列表
注意:此字段可能返回 null,表示取不到有效值。

PodStatus

Pod状态信息

被如下接口引用:DescribeEdgeUnitApplicationPods。

名称 类型 描述
Name String 名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:pod-name
NameSpace String 命名空间
注意:此字段可能返回 null,表示取不到有效值。
示例值:default
Status String 状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:Running
IP String IP地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:1.0.0.0
StartTime String 启动时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2012-01-01 00:00:00
RunSec Integer 运行时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
RestartCount Integer 重启次数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

PortConfig

端口配置

被如下接口引用:CreateApplicationVisualization, CreateEdgeUnitApplicationVisualization, DescribeApplicationVisualization, DescribeEdgeUnitApplicationVisualization, ModifyApplicationVisualization, ModifyEdgeUnitApplicationVisualization。

名称 类型 必选 描述
Protocol String 协议类型(tcp|udp)
示例值:tcp
Port Integer 源端口
示例值:80
TargetPort Integer 目标端口
示例值:80
NodePort Integer 节点端口
示例值:80

Probe

探针配置

被如下接口引用:CreateApplicationVisualization, CreateEdgeUnitApplicationVisualization, DescribeApplicationVisualization, DescribeEdgeUnitApplicationVisualization, ModifyApplicationVisualization, ModifyEdgeUnitApplicationVisualization。

名称 类型 必选 描述
InitialDelaySeconds Integer 启动后,延迟探测时间 单位:秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PeriodSeconds Integer 探测间隔,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TimeoutSeconds Integer 探测超时时间 单位:秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SuccessThreshold Integer 失败后检查成功的最小连续成功次数。默认为1.活跃度必须为1。最小值为1
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
FailureThreshold Integer 当Pod成功启动且检查失败时,放弃之前尝试次数。默认为3.最小值为1
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
HttpProbe HttpProbe HTTP探测配置
注意:此字段可能返回 null,表示取不到有效值。
TcpProbe TcpProbe TCP探测配置
注意:此字段可能返回 null,表示取不到有效值。

ResourceMetricTarget

资源目标指标

被如下接口引用:CreateApplicationVisualization, CreateEdgeUnitApplicationVisualization, DescribeApplicationVisualization, DescribeEdgeUnitApplicationVisualization, ModifyApplicationVisualization, ModifyEdgeUnitApplicationVisualization。

名称 类型 必选 描述
Type String 类型(cpu|memory)
示例值:cpu
AverageValue Integer 平均值
示例值:10
Scale String 单位
示例值:KB
AverageUtilization Integer 平均值
示例值:10

RouteInfo

消息路由

被如下接口引用:DescribeMessageRouteList。

名称 类型 描述
RouteID Integer
RouteName String
SourceProductID String
TopicFilter String
Mode String
TargetOptions String
CreateTime String
Descript String
Healthy String
Status String
MessageCount Integer
MessageLastTime String
SourceProductName String
SourceUnitIDList Array of String
SourceUnitNameList Array of String
SourceDeviceNameList Array of String

SecretItem

Secret信息

被如下接口引用:DescribeSecrets。

名称 类型 描述
Name String Secret名
注意:此字段可能返回 null,表示取不到有效值。
示例值:iecp
Namespace String 命名空间
注意:此字段可能返回 null,表示取不到有效值。
示例值:iecp
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2012-01-01 00:00:00
SecretType String Secret类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:Opaque

SecurityCapabilities

安全能力

被如下接口引用:CreateApplicationVisualization, CreateEdgeUnitApplicationVisualization, DescribeApplicationVisualization, DescribeEdgeUnitApplicationVisualization, ModifyApplicationVisualization, ModifyEdgeUnitApplicationVisualization。

名称 类型 必选 描述
Add Array of String 允许操作列表
注意:此字段可能返回 null,表示取不到有效值。
Drop Array of String 禁止操作列表
注意:此字段可能返回 null,表示取不到有效值。

SecurityContext

安全上下文

被如下接口引用:CreateApplicationVisualization, CreateEdgeUnitApplicationVisualization, DescribeApplicationVisualization, DescribeEdgeUnitApplicationVisualization, ModifyApplicationVisualization, ModifyEdgeUnitApplicationVisualization。

名称 类型 必选 描述
Privilege Boolean 是否开启特权模式
示例值:true
ProcMount String 目录/Proc挂载方式
Capabilities SecurityCapabilities 安全配置

Service

服务配置

被如下接口引用:CreateApplicationVisualization, CreateEdgeUnitApplicationVisualization, DescribeApplicationVisualization, DescribeEdgeUnitApplicationVisualization, ModifyApplicationVisualization, ModifyEdgeUnitApplicationVisualization。

名称 类型 必选 描述
Name String 名称
示例值:test
Type String 类型 (ClusterIP|NodePort)
示例值:ClusterIP
Ports Array of PortConfig 端口配置
Labels Array of Label 标签
Namespace String 命名空间默认default
示例值:default
ClusterIP String 服务IP
示例值:1.0.0.0

Sort

查询结果排序条件

被如下接口引用:DescribeEdgeNodes。

名称 类型 必选 描述
Field String 排序字段
示例值:Name
Order String 排序方式,升序ASC / 降序DESC
示例值:ASC

TcpProbe

TCP探测配置

被如下接口引用:CreateApplicationVisualization, CreateEdgeUnitApplicationVisualization, DescribeApplicationVisualization, DescribeEdgeUnitApplicationVisualization, ModifyApplicationVisualization, ModifyEdgeUnitApplicationVisualization。

名称 类型 必选 描述
Port Integer 连接端口
注意:此字段可能返回 null,表示取不到有效值。
示例值:443

Volume

被如下接口引用:CreateApplicationVisualization, CreateEdgeUnitApplicationVisualization, DescribeApplicationVisualization, DescribeEdgeUnitApplicationVisualization, ModifyApplicationVisualization, ModifyEdgeUnitApplicationVisualization。

名称 类型 必选 描述
Source String 来源(emptyDir|hostPath|configMap|secret|nfs)
示例值:emptyDir
Name String 名称
示例值:test
HostPath VolumeHostPath Host挂载配置
注意:此字段可能返回 null,表示取不到有效值。
ConfigMap VolumeConfigMap ConfigMap挂载配置
注意:此字段可能返回 null,表示取不到有效值。
Secret VolumeConfigMap Secret挂载配置
注意:此字段可能返回 null,表示取不到有效值。
NFS VolumeNFS NFS挂载配置
注意:此字段可能返回 null,表示取不到有效值。

VolumeConfigMap

ConfigMap挂载卷

被如下接口引用:CreateApplicationVisualization, CreateEdgeUnitApplicationVisualization, DescribeApplicationVisualization, DescribeEdgeUnitApplicationVisualization, ModifyApplicationVisualization, ModifyEdgeUnitApplicationVisualization。

名称 类型 必选 描述
Name String 名称
示例值:test
Items Array of VolumeConfigMapKeyToPath Key列表配置

VolumeConfigMapKeyToPath

ConfigMap的key挂载到路径

被如下接口引用:CreateApplicationVisualization, CreateEdgeUnitApplicationVisualization, DescribeApplicationVisualization, DescribeEdgeUnitApplicationVisualization, ModifyApplicationVisualization, ModifyEdgeUnitApplicationVisualization。

名称 类型 必选 描述
Key String 健名
示例值:key
Path String 对应本地路径
示例值:/root
Mode String 对应权限模式
示例值:0777

VolumeHostPath

数据卷主机路径,取值参考: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

被如下接口引用:CreateApplicationVisualization, CreateEdgeUnitApplicationVisualization, DescribeApplicationVisualization, DescribeEdgeUnitApplicationVisualization, ModifyApplicationVisualization, ModifyEdgeUnitApplicationVisualization。

名称 类型 必选 描述
Type String 类型
示例值:FileOrCreate
Path String 路径
示例值:/root

VolumeMount

数据挂载

被如下接口引用:CreateApplicationVisualization, CreateEdgeUnitApplicationVisualization, DescribeApplicationVisualization, DescribeEdgeUnitApplicationVisualization, ModifyApplicationVisualization, ModifyEdgeUnitApplicationVisualization。

名称 类型 必选 描述
Name String 名称
示例值:test
MountPath String 挂载路径
示例值:/root
SubPath String 子路径
注意:此字段可能返回 null,表示取不到有效值。
ReadOnly Boolean 是否只读
注意:此字段可能返回 null,表示取不到有效值。
示例值:false

VolumeNFS

NFS挂载卷

被如下接口引用:CreateApplicationVisualization, CreateEdgeUnitApplicationVisualization, DescribeApplicationVisualization, DescribeEdgeUnitApplicationVisualization, ModifyApplicationVisualization, ModifyEdgeUnitApplicationVisualization。

名称 类型 必选 描述
Server String 服务地址
ServerPath String 对应服务器路径
示例值:/root
Path String 对应本地路径
示例值:/root