You need to enable JavaScript to run this app.
导航
返回结构定义
最近更新时间:2024.05.21 17:58:47首次发布时间:2023.02.22 17:09:42

边缘容器返回结构定义

ApplicationResp

名称

类型

示例值

描述

identity

String

veecc-4110202211206660****

边缘应用 ID。

name

String

test_app

边缘应用名称。

remark

String

测试应用

边缘应用描述。

bind_app_id

String

veecc-4000252292242221****

绑定的边缘应用的 ID。

is_leader_app

bool

false

当前应用是否被其他应用绑定。

workload_count

Int64

2

工作负载数。

status

String

Normal

应用状态:

  • Initialize:未部署
  • ScheduleFailed:调度失败
  • Deploying:部署中
  • Normal:正常
  • DeployFailed:部署失败
  • Terminating:删除中
  • Abnormal:异常

cluster_count

Int64

1

总节点数。

running_cluster_count

Int64

0

运行中节点数。

create_time

Int64

1662607366

创建时间。UNIX时间戳,单位为秒。

update_time

Int64

1662607500

更新时间。UNIX时间戳,单位为秒。

WorkloadResp

名称

类型

示例值

描述

identity

String

res-4110202211206660****

工作负载 ID。

name

String

测试工作负载

工作负载名称。

type

Int64

1

工作负载类型:

  • 1:Deployment
  • 2:Statefulset

spec_name

String

veECC.C1.4-8large

工作负载规格名称。

remark

String

这是一个测试工作负载

工作负载描述。

deploy_strategy

Int64

1

部署策略:

  • 1:滚动更新
  • 2:重建

rolling_size

Int32

1

滚动数量。

max_disable_size

Int32

1

最大不可用数量。

workload_access

WorkloadAccessResp

参考 WorkloadAccessResp

负载访问信息。

spec_info

SpecResp

参考 SpecResp

规格信息。

workload_storage_volumes

[ ] WorkloadStorageVolumeResp

参考 WorkloadStorageVolumeResp

存储盘信息。

create_time

Int64

1662607366

创建时间。UNIX时间戳,单位为秒。

update_time

Int64

1662607500

更新时间。UNIX时间戳,单位为秒。

kata_kernel_version

String

bd-5.4

内核版本:

  • kata-default
  • bd-5.4

enable_public_ip

bool

false

是否购买公网 IP。该参数仅在工作负载类型为 Statefulset 时有返回值。

public_ip_type

int

1

公网 IP 类型。该参数仅在是否购买公网 IP 为true时有返回值:

  • 1: IPv4
  • 3: IPv4&v6

public_ip_bandwidth

int

10000

公网 IP 带宽峰值,单位为 Mbps。该参数仅在是否购买公网 IP 为true时有返回值。

enable_nat

bool

true

是否启用公网访问。开启时,边缘容器将提供 NAT 网关以满足 Pod 访问公网的需求。该项开启后不可关闭。

bandwidth_billing_method

String

DailyPeak

带宽计费方式:

  • DailyPeak:按日峰值计费
  • MonthlyP95:按月 95 峰值计费
  • Traffic:按流量计费

SpecResp

名称

类型

示例值

描述

spec_name

String

veECC.C1.4-8large

规格名称。

cpu

String

4.0

CPU 核数。

mem

String

8GB

内存大小。

WorkloadStorageVolumeResp

名称

类型

示例值

描述

identity

String

res-123123234

存储卷ID。

name

String

存储卷11

存储卷名称。

class

Int64

1

存储类别:

  • 1:Block

type

Int64

2

存储类型:

  • 2:云盘 SSD
  • 4:本地盘 SSD

capacity

Int32

10

存储卷大小,单位:GB。

WorkloadAccessResp

名称

类型

示例值

描述

access_type

Int32

2

接入方式:

  • 1:七层负载均衡
  • 2:Service
  • 3:同时启用七层负载均衡和 Service
  • 4:都不启用
  • 8:四层负载均衡
  • 9:同时启用七层负载均衡和四层负载均衡
  • 10:同时启用四层负载均衡和 Service
  • 11:同时启用七层负载均衡、四层负载均衡和 Service

access_services

[ ] AccessServiceResp

参考 AccessServiceResp

Service 接入配置。

AccessServiceResp

名称

类型

示例值

描述

protocol

String

TCP

协议:

  • TCP
  • UDP

service_port

Int32

80

Service 端口。

container_port

Int32

8080

容器端口。

ContainerResp

名称

类型

示例值

描述

name

String

container11

容器名称。

image_domain

String

imagedomain.cn/public/nginx

镜像地址。

image_version

String

latest

镜像版本。

image_pull_secret_identity

String

res-123234

镜像密钥ID。

cpu

float64

0.5

CPU核数。

mem

float64

1

内存大小。单位:GB。

storage_volumes

[ ] ContainerStorageVolumeResp

参考 ContainerStorageVolumeResp

容器存储卷挂载信息。

ports

[ ] ContainerPortResp

参考 ContainerPortResp

容器端口配置。

cmd

ContainerCmdResp

参考 ContainerCmdResp

容器启动命令。

envs

ContainerEnvResp

参考 ContainerEnvResp

环境变量配置。

mount_configs

ContainerMountConfigResp

参考 ContainerMountConfigResp

配置挂载信息。

readiness_probe

ContainerProbeResp

参考 ContainerProbeResp

就绪检查。

liveness_probe

ContainerProbeResp

参考 ContainerProbeResp

存活检查。

post_start

HandlerResp

参考 HandlerResp

生命周期操作(启动后)。

pre_stop

HandlerResp

参考 HandlerResp

生命周期操作(停止前)。

ContainerStorageVolumeResp

名称

类型

示例值

描述

volume_name

String

volume1

工作负载存储卷名称。

mount_path

String

/disk

挂载路径。

ContainerPortResp

名称

类型

示例值

描述

name

String

port1

端口名称。

protocol

String

UDP

端口协议:

  • TCP
  • UDP

port

int32

80

端口号。

ContainerCmdResp

名称

类型

示例值

描述

cmd

String

ls

启动命令。

params

[ ] String

["-a"]

启动命令参数。

ContainerEnvResp

名称

类型

示例值

描述

type

int32

1

环境变量类型:

  • 1:键值对
  • 2:Configmap
  • 3:Secret

key

String

key1

键值对中的 Key。type1时需要指定 Key。

value

String

res-123123

环境变量值。type23时取对应 Configmap 或 Secret 的 ID。

ContainerMountConfigResp

名称

类型

示例值

描述

type

int32

1

所挂载配置类型:

  • 1:Configmap
  • 2:Secret

ref_id

String

res-123123312

所挂载的配置文件/密钥文件的 ID。

mount_path

String

/config1

挂载路径。

ContainerProbeResp

名称

类型

示例值

描述

handler

HandlerResp

参考 HandlerResp

具体操作内容。

initial_delay_seconds

int32

1

延时时间,单位:秒。

timeout_seconds

int32

1

超时时间,单位:秒。

period_seconds

int32

1

间隔时间,单位:秒。

success_threshold

int32

1

所需次数。

failure_threshold

int32

1

重试次数。

HandlerResp

名称

类型

示例值

描述

handler_type

int32

1

操作类型:

  • 1:执行命令
  • 2:发送 GET 请求

exec

ExecActionResp

参考 ExecActionResp

handler_type1时对应的操作。

http_get

HTTPGetActionResp

参考 HTTPGetActionResp

handler_type2时对应的操作。

HTTPGetActionResp

名称

类型

示例值

描述

path

String

/healthcheck

HTTP 请求路径。

port

Int32

80

请求端口。

ExecActionResp

名称

类型

示例值

描述

command

String

ls -a

所执行的命令。

PodResp

名称

类型

示例值

描述

container_status

[ ]
ContainerStatus

参考 ContainerStatus

容器状态信息。

inner_ips

[ ]String

["10.xx.xx.160", "fdbd:dc04:64:18::xx:xx"]

内网 IP。

name

String

res-50452542201060020****

Pod 名称。

public_ips

[ ]String

["36.xx.xx.168", "2409:8c20:3c41:2b:8000:0:xx:xx"]

公网 IP。

restart_count

Int64

0

重启次数。

start_time

Int64

1672085713

创建时间。UNIX时间戳,单位为秒。

status

String

Running

状态:

  • Running: 运行中
  • Terminating:终止中
  • Pending:等待中
  • Error:异常

CotainerStatus

名称

类型

示例值

描述

container_name

String

container11

容器名称。

ready

Bool

true

是否就绪。

reason

String

Running(Ready)

原因信息。

restart_count

Int64

0

重启次数。

AppClusterResp

名称

类型

示例值

描述

alias

String

**测试集群

集群别名。

city

String

460101

城市。

cluster_name

String

**-test

集群名。

component_info_list

[ ]
ComponentInfo

参考 ComponentInfo

组件信息。

isp

String

CUCC

运营商。

region

String

SouthChina

区域。

status

String

Normal

部署状态:

  • Pending:等待中
  • Deploying:部署中
  • DeployFailed:部署失败
  • Normal:正常
  • Abnormal:异常
  • Deleting:删除中

target_version

String

1.0.0

期望版本号。

version

String

1.0.0

实际版本号。

workload_info

String

1/1

正常工作负载数/总工作负载数。

create_time

Int64

1670913606

创建时间。UNIX时间戳,单位为秒。

ComponentInfo

名称

类型

示例值

描述

kind

String

LB4

组件名:

  • LB4:四层负载均衡
  • LB7:七层负载均衡
  • Workload:工作负载

status

String

NotConfigured

组件状态:

  • Normal:正常
  • Abnormal:异常
  • NotConfigured:未配置
  • ""(空字符串):状态获取中

AppVersionResp

名称

类型

示例值

描述

application_identity

String

veecc-01710404114024321100

应用 ID。

status

String

InUse

版本状态:

  • Initialize:未部署
  • InUse:使用中

remark

String

这是1.0.0版本

版本描述。

version

String

1.0.0

版本号。

action

AppVersionAction

参考 AppVersionAction

版本相关操作是否运行。

create_time

Int64

1672898890

创建时间。UNIX时间戳,单位为秒。

AppVersionAction

名称

类型

示例值

描述

can_delete

bool

true

能否删除。

can_deploy

bool

false

能否全量部署。

can_gray

bool

true

能否灰度。

VeeccRegionInfo

名称

类型

示例值

描述

area

String

NorthChina

大区。

city

String

120000

城市。

isp

String

CMCC

运营商。

cluster

String

****-test01

集群

available_num

Int64

1

可用的集群数量。

ApplicationPlacementResp

名称

类型

示例值

描述

region

String

region1

区域。

city

String

12400

城市。

isp

String

CTCC

运营商。

cluster_name

String

hkun-test

集群名。

replicas

int32

2

申请节点数。

ResourceAvailableItem

名称

类型

示例值

描述

resource_type

String

computing_resource

资源检查项类型:

  • cluster:集群可用性
  • computing_resource:算力资源可用性
  • pod_ip:pod ip资源可用性

available

Bool

true

检查项是否通过。

app_placements

[ ] ApplicationPlacementResp

参考 ApplicationPlacementResp

如果检查不通过,不通过的区域、城市、运营商、集群信息。

PodInstance

名称

类型

示例值

描述

pod_name

String

res-2188182581113200****

Pod 名称。

app_id

String

veecc-7715435870344851****

应用ID。

app_name

String

public-ip__副本1

应用名称。

region

String

EastChina

大区。

city

String

330200

城市。

isp

String

CTCC

运营商。

pod_uid

String

b7b8ed1e-7b9e-4b9f-87a5-35d4dfc8****

Pod UID。

cluster_name

String

hkun-test

集群英文名。

cluster_alias

String

海口联通网络测试集群

集群中文名。

public_ips

[]String

["114.251.."]

公网ip。

inner_ips

[]String

[
"192.168..",
"fc00:::"
]

内网ip。

workload_id

String

res-2188182581113200****

工作负载ID。

app_version

String

1.0.1

Pod所属应用版本。

restart_count

int64

0

重启次数。

start_time

int64

1702365816

创建时间。UNIX时间戳,单位为秒。

spec_name

string

veECC.MC1.0-1large

规格名称。参见容器规格定义

status

String

Running

状态:

  • Pending:等待中
  • Running:运行中
  • Terminating:删除中
  • Succeeded:成功
  • Failed:失败
  • Unknown:未知