Loading
close

负载

time 更新时间:2024-07-24 10:34:45

负载

创建/添加负载

URI

示例:product_type_list=[eks, hybrid, security]

POST /api/ecns/${product type}/workloads/

请求消息

参数 参数类型 是否必选 描述
workloads list(workload) 工作负载,workload Type定义见前文

workload Type定义:

参数 参数类型 是否必选 描述
application_name str 在”应用创建页面->添加负载页面”,需要填写应用名称; 在单独的”负载创建”页面,则不填
application_type str 应用类型,Normal / Hybrid,默认是Normal
workload_base workload_base workload_base Type见后文
security_groups list(str) 混合编排需要设置, 网络安全组
labels dict(str:str) 标签,”labels”:{“k1”:”v1”, “k2”:”v2”}
access_mode list(access_mode) 访问方式,access_mode Type见后文
vm_access loadbalancer 云主机访问入口,混合编排的容器负载使用,loadbalancer Type定义见后文
vm_network vm_network 云主机网络,创建时允许为空,因为混合编排的容器负载只能走应用创建入口,application的数据结构里已经有vm_network,这里加入是为了展示容器负载时使用
runtime_class_name str 运行时类名称;在安全容器场景创建工作负载时,默认传入值 rune
containers list(container) 容器配置列表,container Type见后文
volumes list(volume) 存储卷列表 – 新增字段
update_strategy update_strategy 升级策略,update_strategy Type见后文
scale_strategy scale_strategy 伸缩策略,开启才填写,scale_strategy Type见后文
scheduler_strategy list(scheduler_strategy) 调度策略,scheduler_strategy Type见后文
network network 网络设置,network Type见后文
pods_status list(pod_status) 容器组状态,pod_status Type见后文,前端不填写
workload_status workload_status 工作负载的状态,获取工作负载时,后端会一并返回工作负载的定义和状态,前端不填写

workload_base Type定义:

参数 参数类型 是否必选 描述
name str 工作负载名称(唯一性校验)
type str 类型:Deployment, StatefulSet, DaemonSet
replicas int 副本数,DaemonSet类型不填

access_mode Type定义:

参数 参数类型 是否必选 描述
name str 对应的k8s service名称,负载详情页面用,创建时不填
type str ClusterIP, NodePort, LoadBalancer, ExternalName
external_name str ExternalName类型时,需要填写目标域名
cluster_ip str 类型是ClusterIP,即作为参数也是回显数据,当类型是其他时,需要返回IP的则复用这个字段
public_ips list[str] 类型是NodePort,ip地址是所有master节点的; LoadBalance,负载均衡器公网ip
private_ips list[str] 类型是NodePort,ip地址是所有节点的内网ip地址
access list(access) access Type 定义见后文
annotations dict(str:str) 对应svc的注解
external object 类型是LoadBalancer,作为参数和回显数据,类型是其他时,此项返回值为null.请求和返回的数据结构体存在一定差异请求参考external-request,返回参考external-responce.
subnet string 对应LB service的subnet信息,类型是其他时,此项返回值为null.

external-request Type的定义:

参数 参数类型 是否必选 描述
availability_zone_profile availability_zone_profile optional LB可用区信息
flavor_profile flavor_profile optional LB规格信息
loadbalancer loadbalancer required 其他LB信息

availability_zone_profile Type的定义

参数 参数类型 是否必选 描述
availability_zone_data availability_zone_data optional LB可用区信息

availability_zone_data Type的定义

参数 参数类型 是否必选 描述
compute_zone string optional LB可用区,示例值default-az
cpu_arch string optional cpu架构,示例值x86_64

flavor_profile Type定义

参数 参数类型 是否必选 描述
flavor_data flavor_data optional LB规格

flavor_data Type定义

参数 参数类型 是否必选 描述
amp_volume_type string optional LB虚机盘类型
compute_flavor string optional 计算规格
loadbalancer_topology string required 负载均衡器拓扑

loadbalancer Type定义

参数 参数类型 是否必选 描述
name string required 负载均衡器名称
vip_subnet_id string required 负载均衡器子网id

external-responce的定义:

参数 参数类型 描述
admin_state_up boolean 负载均衡器的管理状态。true表示启用,false表示停用。
availability_zone object 可用区名称。
created_at string 负载均衡器创建的时间。
描述 string 负载均衡器的描述。
flavor_id uuid 规格的ID。
id uuid 负载均衡器的ID。
listeners array 负载均衡器关联的监听器的ID。
loadbalancers array loadbalancer对象列表。
name string 负载均衡器的名称。
operating_status string 负载均衡器的运行状态。
pools array 负载均衡器关联的资源池ID。
project_id string 负载均衡器所属的项目ID。
provider string 负载均衡器的提供者名称。
provisioning_status string 负载均衡器的配置状态。
tags list 标签。
updated_at string 负载均衡器最后一次更新的时间
vip_address string VIP的IP地址。
vip_network_id uuid VIP的网络ID。
vip_port_id uuid VIP端口的ID。
vip_qos_policy_id uuid VIP的QoS策略的ID。
vip_subnet_id uuid VIP的子网ID。

access Type定义:

参数 参数类型 是否必选 描述
port int 映射服务端口
protocol str 协议 TCP / UDP
node_port int 主机端口
target_port int 容器端口
routers list(router) 路由配置

router Type定义:

参数 参数类型 是否必选 描述
domain str 域名
path str 路径
target_service str 目标服务
service_port int 服务端口

container Type定义:

参数 参数类型 是否必选 描述
name str 容器名称
type str 容器类型 worker 或 init
image image 容器镜像
image_source str 镜像来源,值范围:ecns, third_party
resources resources resources Type定义见后文
env list(env) env Type定义见后文
volume_mounts list(volume_mount) volume_mount Type定义见后文 – 新增字段
logsidecar_injector list(str) 日志注入绝对路径,类型为字符串列表
health list(health) 健康检查,health Type定义见后文
security security 安全设置,security Type定义见后文
commands command 启动命令,页面选择自定义后才填,command Type定义见后文
hooks list(hook) 容器钩子,hook Type定义见后文
container_status str 前端不填,从后端获取,值范围:Running, Waiting, Terminated, Error

image Type定义:

参数 参数类型 是否必选 描述
harbor_project_name str 在image_source为 ecns 时填写,值为所选择镜像的harbor_project_name值
image str 容器镜像地址
image_version str 镜像版本
image_auth bool
image_secret str 密钥
image_pull_policy str 镜像拉取策略:Always 或 IfNotPresent

resources Type定义:

参数 参数类型 是否必选 描述
requests resource 资源预留,格式:{“cpu”: 0.1, “memory”: 1024},cpu的数值类型是float,memory的数值类型是int
limits resource 资源限制,格式同上

env Type定义:

参数 参数类型 是否必选 描述
type str 类型:Normal, ConfigMap, Secret
name str 环境变量的名称
value str 类型为ConfigMap/Secret,value表示configmap里的subpath。类型为normal时不填
key str 类型为ConfigMap/value时,key表示configmap/secret的名称。类型为normal时表示环境变量的值

volume Type定义:

参数 参数类型 是否必选 描述
name str
type str 类型范围:StorageClass, PVC, LocalStorage, EmptyDir,ConfigMap,Secret
storage_class storage_class 格式:{“class_name”:”general”, “capacity”:”10”},仅StorageClass类型填写
pvc pvc 由后端持久化卷API提供pvc列表给前端下拉框选择,仅PVC类型填写
local_storage str 主机路径,例如/var/run,仅LocalStorage类型填写
emptydir str
configmap config
secret config

volume_mount Type定义:

参数 参数类型 是否必选 描述
volume_name str 对应的存储卷名称
mount_path str 挂载到指定目录下,比如/tmp
read_only bool
sub_path str

mount Type定义:

参数 参数类型 是否必选 描述
mount_path str 挂载到指定目录下,比如/tmp
read_only bool

config Type定义:

参数 参数类型 是否必选 描述
type str ConfigMap 或 Secret
name str ConfigMap 或 Secret的名称
path str 容器路径
items list(item) item Type定义见后文

item Type定义:

参数 参数类型 是否必选 描述
key str 由后端configmap api提供key列表给前端下拉框选择
path str 子路径和文件名,例如conf/config.property

health Type定义:

参数 参数类型 是否必选 描述
type str 存活检查:liveness,就绪检查:readiness, 启动检查: startup
protocol str http, https, tcp, cmd
host str Host name to connect to, defaults to the pod IP.
path str http/https时填写
cmd str 命令行时填写
port int 检测端口
initial_delay int 开始检测之前的延迟时间
period int 检测周期
timeout int 检测的超时时间
success_threshold int 判定health ok的成功次数,当type是liveness时,success_threshold必须是1
failure_threshold int 判定health fail的失败次数

security Type定义:

参数 参数类型 是否必选 描述
run_as_nonroot bool true 或 false
rootfs_readonly bool true 或 false
host_pid bool true 或 false
host_ipc bool true 或 false
run_as_user int 以指定用户id运行
run_as_group int 以指定用户组id运行
privileged bool true 或 false-
capabilities dict(str:str, str:list) linux内核能力参考:capabilities(7) - Linux manual page ,格式举例:{“action”: “add”,”caps”: [“NET_BIND_SERVICE”]},,add表示添加能力,能力项为NET_ADMIN; 移除能力用drop。capabilities列表由后端提供接口给前端查询

command Type定义:

参数 参数类型 是否必选 描述
cmd list(str) 字符串数组,后端用空格连接为完整命令行
args list(str) 参数数组,后端用空格连接为完整参数行

hook Type定义:

参数 参数类型 是否必选 描述
type str PreStop 或 PostStart
cmd list(str)

update_strategy Type定义:

参数 参数类型 是否必选 描述
type str first_up, fisrt_down, recreate, custom,rolling_update, on_delete
batch_size int 批量执行pod的数量
max_surge int 最大超量
max_unavailable int 最多不可用数
period int 更新间隔

scale_strategy Type定义:

参数 参数类型 是否必选 描述
min_replicas int
max_replicas int
resource resource 格式举例: {“cpu”: 20, “memory”: 20},数值表示百分数,int类型

resource Type定义:

参数 参数类型 是否必选 描述
cpu int
memory int

scheduler_strategy Type定义:

参数 参数类型 是否必选 描述
type podAffinity, podAntiAffinity, nodeSelector(指定主机), nodeSelectorTerms(自定义主机规则)
node_selector scheduler_rule 主机调度策略
pod_affinity scheduler_rule pod 亲和性调度策略
pod_anti_affinity scheduler_rule pod 反亲和性调度策略
node_terms scheduler_rule 主机自定义规则策略

required_prefered Type定义:

参数 参数类型 是否必选 描述
topology_key str 拓扑域
expression list(scheduler_expression)

scheduler_expression Type定义:

参数 参数类型 是否必选 描述
key str 主机标签键
operator str In, NotIn, Gt, Lt, Exists, DoesNotExist
values str
weight int

network Type定义:

参数 参数类型 是否必选 描述
host_network bool true 或 false
dns_policy str ClusterFirst 或 ClusterFirstWithHostNet
host_aliases list(dict) 格式为[{“ip”:”xxx”, “hostnames”: “bar.remote.com“}, {“ip”:”yyy”, “hostnames”: “zoo.remote.com“}]

批量关联负载

URI

示例:product_type_list=[eks, hybrid, security]

PUT /api/ecns/${product type}/workloads/?action=attach

请求消息

参数 参数类型 是否必选 描述
application_name str 应用名称
workloads_base list(workload_base) workload_base Type见前文,此处不填replicas

批量解除关联

URI

示例:product_type_list=[eks, hybrid, security]

PUT /api/ecns/${product type}/workloads/?action=detach

请求消息

参数 参数类型 是否必选 描述
application_name str 应用名称
workloads_base list(workload_base) workload_base Type见前文,此处不填replicas

批量删除负载

URI

示例:product_type_list=[eks, hybrid, security]

DELETE /api/ecns/${product type}/workloads/

请求消息

参数 参数类型 是否必选 描述
workloads_base list(workload_base) workload_base Type见前文,此处不填replicas
delete_policy str 删除负载和负载创建资源的策略,默认不传.安全容器填 ‘Foreground’
force_delete bool 默认不传,如需强制删除,置为true
delete_service bool 默认不传,如需删除关联service资源,置为true

批量启动负载

URI

示例:product_type_list=[eks, hybrid, security]

PUT /api/ecns/${product type}/workloads/?action=start

请求消息

参数 参数类型 是否必选 描述
workloads_base list(workload_base) workload_base Type见前文,此处不填replicas

批量停止负载

URI

示例:product_type_list=[eks, hybrid, security]

PUT /api/ecns/${product type}/workloads/?action=stop

请求消息

参数 参数类型 是否必选 描述
workloads_base list(workload_base) workload_base Type见前文,此处不填replicas

重新部署负载

URI

示例:product_type_list=[eks, hybrid, security]

PUT /api/ecns/${product type}/workloads/?action=recreate

请求消息

参数 参数类型 是否必选 描述
workloads_base list(workload_base) workload_base Type见前文,此处不填replicas

负载列表

URI

示例:product_type_list=[eks, hybrid, security]

GET /api/ecns/${product type}/workloads/?page=5&page_size=20&workload_type=<workload_type>

请求消息

参数 参数类型 是否必选 描述
workloads lit(workload Type) 负载列表

负载access mod

URI

示例:product_type_list=[eks, hybrid, security]

GET /api/ecns/${product type}/workloads/workload/<workload_name>/access/?workload_type=<workload_type>

请求消息

参数 参数类型 是否必选 描述
access_mod access_mod access mod详情

负载containers

URI

示例:
product_type_list=[eks, hybrid, security]

GET /api/ecns/${product type}/workloads/workload/<workload_name>/containers/?workload_type=<workload_type>

请求消息

参数 参数类型 是否必选 描述
containers list(container) worload下的container详情

“手动伸缩”操作

url

示例:
product_type_list=[eks, hybrid, security]

PATCH /api/ecns/${product type}/workloads/workload/<workload_name>/?action=scale&workload_type=<workload_type>

请求消息

参数 参数类型 是否必选 描述
replicas int 工作负载的副本数

响应消息

参数 参数类型 描述
workload workload type workload情况

“访问方式”操作

URI

示例:product_type_list=[eks, hybrid, security]

PATCH /api/ecns/${product type}/workloads/workload/<workload_name>/?action=access_modes&workload_type=<workload_type>

请求消息

参数 参数类型 是否必选 描述
access_modes list(access_mode) 访问方式列表列表,参见access_mode Type定义

“容器组配置”操作

URI

示例:product_type_list=[eks, hybrid, security]

PATCH /api/ecns/${product type}/workloads/workload/<workload_name>/?action=containers&workload_type=<workload_type>

请求消息

参数 参数类型 是否必选 描述
containers list(container) container列表,参见container Type定义

响应消息

参数 参数类型 描述
workload workload type workload情况

“升级策略”操作

URI

示例:
product_type_list=[eks, hybrid, security]

PATCH /api/ecns/${product type}/workloads/workload/<workload_name>/?action=update_strategy&workload_type=<workload_type>

请求消息

参数 参数类型 是否必选 描述
update_strategy update_strategy 参见update_strategy Type

响应消息

参数 参数类型 描述
workload workload type workload情况

版本信息获取

URI

示例:product_type_list=[eks, hybrid, security]

GET /api/ecns/${product type}/workloads/workload/<workload_name>/revisions/?workload_type=<workload_type>

响应消息

参数 参数类型 描述
revisions list(revision) 参见revision Type

版本历史yaml获取

URI

示例:product_type_list=[eks, hybrid, security]

GET /api/ecns/${product type}/workloads/workload/<workload_name>/revision/<version>/yaml/?workload_type=<workload_type>

响应消息

返回值为负载历史yaml

“版本回滚”操作

URI

示例:product_type_list=[eks, hybrid, security]

PATCH /api/ecns/${product type}/workloads/workload/<workload_name>/?action=rollback&workload_type=<workload_type>

请求消息

参数 参数类型 是否必选 描述
target_version str

响应消息

参数 参数类型 描述
workload workload type workload情况

“伸缩策略”操作

URI

示例:product_type_list=[eks, hybrid, security]

PATCH /api/ecns/${product type}/workloads/workload/<workload_name>/?action=scale_strategy&workload_type=<workload_type>

请求消息

参数 参数类型 是否必选 描述
scale_strategy scale_strategy

响应消息

参数 参数类型 描述
workload workload type workload情况

“调度策略”操作

URI

示例:product_type_list=[eks, hybrid, security]

PATCH /api/ecns/${product type}/workloads/workload/<workload_name>/?action=scheduler_strategy&workload_type=<workload_type>

请求消息

参数 参数类型 是否必选 描述
scheduler_strategy list(scheduler_strategy)

响应消息

参数 参数类型 描述
workload workload type workload情况

“网络设置”操作

URI

示例:product_type_list=[eks, hybrid, security]

PATCH /api/ecns/${product type}/workloads/workload/<workload_name>/?action=network&workload_type=<workload_type>

请求消息

参数 参数类型 是否必选 描述
network network

“标签设置”操作

URI

示例:product_type_list=[eks, hybrid, security]

PATCH /api/ecns/${product type}/workloads/workload/<workload_name>/?action=labels&workload_type=<workload_type>

请求消息

参数 参数类型 是否必选 描述
labels dict(str:str)

响应消息

参数 参数类型 描述
workload workload type workload情况

“停止”操作

URI

示例:product_type_list=[eks, hybrid, security]

PUT /api/ecns/${product type}/workloads/workload/<workload_name>/?action=stop&workload_type=<workload_type>

“启动”操作

URI

示例:product_type_list=[eks, hybrid, security]

PUT /api/ecns/${product type}/workloads/workload/<workload_name>/?action=start&workload_type=<workload_type>

“重新部署”操作

URI

示例:product_type_list=[eks, hybrid, security]

PUT /api/ecns/${product type}/workloads/workload/<workload_name>/?action=recreate&workload_type=<workload_type>

负载详情(包含状态,事件,历史版本)

URI

示例:product_type_list=[eks, hybrid, security]

GET /api/ecns/${product type}/workloads/workload/<workload_name>/?workload_type=<workload_type>

响应消息

参数 参数类型 描述
conditions list(condition) 工作负载状态列表
events list(event) 工作负载事件列表
revisions list(revision) 工作负载历史版本列表
workload workload workload Type定义见前文

condition Type定义:

参数 参数类型 是否必选 描述
status str Status of the condition, one of True, False, Unknown
type str 工作负载类.
reason str 工作负载异常原因
message str 工作负载异常详细信息
update_time str 工作负载更新时间

event Type定义

参数 参数类型 是否必选 描述
type str 事件类型:Normal, Warning
reason str 工作负载异常原因
message str 工作负载异常详细信息
update_time str 工作负载更新时间

revision Type定义

参数 参数类型 是否必选 描述
version int 版本号
image list(image)
creation_time str 历史版本创建时间

负载伸缩策略

URI

示例:product_type_list=[eks, hybrid, security]

GET /api/ecns/${product type}/workloads/workload/<workload_name>/scale_strategy?workload_type=<workload_type>

响应消息

参数 参数类型 描述
scale_strategy scale_strategy

负载调度策略

URI

示例:product_type_list=[eks, hybrid, security]

GET /api/ecns/${product type}/workloads/workload/<workload_name>/scheduler_strategy?workload_type=<workload_type>

响应消息

参数 参数类型 描述
scheduler_strategy scheduler_strategy

负载网络设置信息

URI

示例:product_type_list=[eks, hybrid, security]

GET /api/ecns/${product type}/workloads/workload/<workload_name>/network?workload_type=<workload_type>

响应消息

参数 参数类型 描述
network network

负载历史版本删除

URI

示例:product_type_list=[eks, hybrid, security]

DELETE /api/ecns/${product type}/workloads/workload/<workload_name>/revisions/?history_version=<version_id>&workload_type=<workload_type>

负载历史版本批量删除

URI

示例:product_type_list=[eks, hybrid, security]

DELETE /api/ecns/${product type}/workloads/workload/<workload_name>/revisions/?workload_type=<workload_type>

请求消息

参数 参数类型 是否必选 描述
revisions list[revision] 参见revision Type
此篇文章对你是否有帮助?
没帮助
locked-file

您暂无权限访问该产品