You need to enable JavaScript to run this app.
导航

请求结构定义

最近更新时间2024.01.15 15:04:13

首次发布时间2023.02.22 17:09:42

边缘容器请求结构定义

Workload

名称

类型

是否必选

示例值

描述

identity

String

res-2232003214331223****

工作负载ID。
编辑工作负载时,需指定该参数。创建边缘应用时,无需指定该参数。

name

String

workload****

工作负载名称。

type

Int32

1

工作负载类型,取值范围:

  • 1:Deployment
  • 2:Statefulset

编辑工作负载时,该参数的值不可修改。

spec_name

String

veECC.C1.0-1large

规格名。参考 容器规格定义

remark

String

描述内容

工作负载描述。

deploy_strategy

Int32

1

发布策略,取值范围:

  • 1:滚动发布
  • 2:重建

rolling_size

Int32

1

滚动数量,非必填。当deploy_strategy值为滚动发布时必填。默认值为 0,取值范围为 0-100。

max_disable_size

Int32

1

最大不可用数,非必填,以百分比表示。当deploy_strategy值为滚动发布时为必填。取值范围为 0-100(该数值代表百分号前的数值)。

workload_access

WorkloadAccess

参考 WorkloadAccess

工作负载接入方式。

workload_storage_volumes

[ ]
WorkloadStorageVolume

参考WorkloadStorageVolume

工作负载存储卷。

kata_kernel_version

String

bd-5.4

内核版本,默认取值为kata-default, 取值范围如下:

  • kata-default
  • bd-5.4

enable_public_ip

Bool

false

是否购买公网IP,默认取值为false,工作负载类型为Statefulset时可以选择购买公网IP。

public_ip_type

Int

1

公网IP类型,只有购买公网IP时需传入,取值范围

  • 1: IPv4
  • 3: IPv4 & IPv6

public_ip_bandwidth

Int

10000

公网 IP 带宽峰值,单位 Mbps,只有购买公网 IP 时需传入。该数值需大于 0、并且为 5 的整数倍。

enable_nat

bool

true

是否启用公网访问。开启后,将提供 NAT 网关以满足 Pod 访问公网的需求。默认取值为 false。
该项开启后不可关闭。

bandwidth_billing_method

String

DailyPeak

带宽计费方式。取值范围:

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

默认取值为 DailyPeak,该值指定后不可修改。

WorkloadStorageVolume

名称

类型

是否必选

示例值

描述

identity

String

res-0239259020990231****

存储卷 ID。
创建边缘应用时,无需指定该参数。
编辑工作负载时,如果存在存储卷,需指定该参数;如果不存在存储卷,无需指定该参数。

name

String

workload****

工作负载名称。

class

Int32

1

存储类别:

  • 1:Block

type

Int32

2

存储类型:

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

capacity

Int32

10

容量大小

WorkloadAccess

名称

类型

是否必选

示例值

描述

access_type

Int32

2

接入方式,取值范围如下:

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

access_services

[ ]
AccessService

参考 AccessService

Service 接入配置

AccessService

名称

类型

是否必选

示例值

描述

protocol

String

TCP

协议,取值范围如下:

  • TCP
  • UDP

service_port

Int32

80

Service 端口,取值范围:1-65535。

container_port

Int32

8080

容器端口,取值范围:1-65535。

Container

名称

类型

是否必选

示例值

描述

identity

String

res-2143023227312010****

容器 ID。
创建边缘应用时,无需指定该参数。
编辑工作负载时,如果存在容器,需指定该参数;如果不存在容器,无需指定该参数。

name

String

container11

容器名称。

image_domain

String

imagedomain.cn/public/nginx

镜像地址。

image_version

String

latest

镜像版本。

image_pull_secret_identity

String

res-12****

镜像密钥ID。

cpu

Float64

0.5

CPU 核数。

mem

Float64

1

内存大小(GB)。

storage_volumes

[ ]
ContainerStorageVolume

参考 ContainerStorageVolume

容器存储卷挂载信息。

ports

[ ]
ContainerPort

参考 ContainerPort

容器端口配置。

cmd

ContainerCmd

参考 ContainerCmd

容器启动命令。

envs

ContainerEnv

参考 ContainerEnv

环境变量配置。

mount_configs

ContainerMountConfig

参考 ContainerMountConfig

配置挂载信息。

readiness_probe

ContainerProbe

参考 ContainerProbe

就绪检查。

liveness_probe

ContainerProbe

参考 ContainerProbe

存活检查。

post_start

Handler

参考 Handler

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

pre_stop

Handler

参考 Handler

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

privileged

Bool

true

是否启用特权容器,默认关闭。

ContainerStorageVolume

名称

类型

是否必选

示例值

描述

volume_name

String

volume1

工作负载存储卷名称。

mount_path

String

/disk

挂载路径。必须以 / 开头,不能超过 50 个字符,只能包含数字、字母、句点(.)、下划线(-)。

ContainerPort

名称

类型

是否必选

示例值

描述

name

String

port1

端口名称。不能超过 15 个字符,仅支持小写字母、数字和连字符(-),至少包含一个字母, 不能以连字符开头和结尾且不能出现连续两个连字符。

protocol

String

UDP

端口协议,取值范围如下:

  • TCP
  • UDP

port

Int32

80

端口号,取值范围1-65535。

ContainerCmd

名称

类型

是否必选

示例值

描述

cmd

String

ls

启动命令。

params

[ ]String

["-a"]

启动命令参数。

ContainerEnv

名称

类型

是否必选

示例值

描述

type

Int32

1

环境变量类型,取值范围:

  • 1:键值对
  • 2:configmap
  • 3:secret

key

String

key1

键值对中的 Key,当 type1时需要配置该参数。只能以连字符(-)、句点(.)、下划线()和字母开头,只能包含连字符(-)、句点(.)、下划线()、数字和字母。

value

String

res-12****

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

ContainerMountConfig

名称

类型

是否必选

示例值

描述

type

Int32

1

所挂载配置类型,取值范围:

  • 1:Configmap
  • 2:Secret

ref_id

String

res-12312****

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

mount_path

String

/config1

挂载路径。

ContainerProbe

名称

类型

是否必选

示例值

描述

handler

Handler

参考 Handler

具体操作内容。

initial_delay_seconds

Int32

1

延时时间,取值范围为 1-60。

timeout_seconds

Int32

1

超时时间,取值范围为 1-60。

period_seconds

Int32

1

间隔时间,取值范围为 1-60。

success_threshold

Int32

1

所需次数,取值范围为 1-20。

failure_threshold

Int32

1

重试次数,取值范围为 1-20。

Handler

名称

类型

是否必选

示例值

描述

handler_type

Int32

1

操作类型,取值范围:

  • 1:执行命令
  • 2:发送 GET 请求
  • 3:TCP 检查(仅针对健康检查生效)

exec

ExecAction

参考 ExecAction

handler_type1时必填。

http_get

HTTPGetAction

参考 HTTPGetAction

handler_type2时必填。

tcp_socket

TCPSocketAction

参考 TCPSocketAction

handler_type3时必填。

HTTPGetAction

名称

类型

是否必选

示例值

描述

path

String

/healthcheck

HTTP 请求路径。

port

Int32

80

请求端口。

ExecAction

名称

类型

是否必选

示例值

描述

command

String

ls -a

所执行的命令。

TCPSocketAction

名称

类型

是否必选

示例值

描述

port

Int32

80

TCP 检查端口。

ApplicationPlacement

名称

类型

是否必选

示例值

描述

region

String

region1

区域。

city

String

12400

城市。

isp

String

CTCC

运营商。

cluster_name

String

****-test

集群名。

replicas

Int32

2

申请节点数。

CreateApplicationParam

名称

类型

是否必选

示例值

描述

name

String

边缘容器应用1

应用名称,用户级别唯一。长度必须在5-20之间, 且不能包含空白字符、不能以 / 开头。

remark

String

应用描述文字

应用描述。最多80个字符。

bind_app_id

String

veecc-4000252292242221****

绑定到的边缘应用的id。
选择需绑定的应用后,将自动复制该应用的部署信息,如果应用的部署信息发生变化,结果将会同步至当前应用。
无法绑定到一个已绑定到其他应用的子应用。

workload

Workload

参考 Workload

工作负载信息。

containers

[ ]Container

参考 Container

容器列表。

placements

[ ]ApplicationPlacement

参考 ApplicationPlacement

部署节点列表。您可以通过获取可部署城市运营商列表接口查询。

DeployAppVersionParam

名称

类型

是否必选

示例值

描述

app_id

String

veecc-4110202211206660****

边缘应用ID。

version_no

String

1.0.0

部署的版本号。您可以通过获取应用版本列表接口查询。

app_placements

[ ]ApplicationPlacement

参考 ApplicationPlacement

部署节点列表。默认部署当前应用已配置的所有部署节点。您可以通过获取应用的已配置节点列表接口查询。