应用管理
列举应用
功能介绍
列举应用和应用类型
URI
示例:product_type_list=[eks, hybrid]
GET /api/ecns/${product type}/applications/?type=<application_type>&page=5&page_size=20
参数 | 参数类型 | 是否必选 | 描述 |
---|---|---|---|
type | str | 否 | 区分是混编应用还是普通容器应用,Normal / Hybrid,默认是Normal |
响应消息
参数 | 参数类型 | 描述 |
---|---|---|
applications_info | list(application_info) | 应用列表,application的Type的定义在后文。 |
创建应用
功能介绍
以应用名称为主键创建应用
URI
示例:product_type_list=[eks, hybrid]
POST /api/ecns/${product type}/applications/
请求消息
application Type定义:
参数 | 参数类型 | 是否必选 | 描述 |
---|---|---|---|
name | str | 是 | 应用名称(唯一性校验) |
description | str | 否 | 应用描述 |
type | str | 否 | 应用类型,Normal / Hybrid,默认是Normal |
vm_network | vm_network | 否 | 云主机网络,vm_network Type见后文,后端数据结构定义里是optional,但在混合编排类型不允许为空 |
configmaps | list(configmap) | 否 | 混合编排创建配置时填写 |
workloads | list(workload) | 否 | 容器负载类型 |
virtual_machines | list(virtual_machine) | 否 | 云主机负载类型 |
响应消息
参数 | 参数类型 | 描述 |
---|---|---|
application_info | application_info | 应用信息 |
修改应用描述信息
功能介绍
根据请求修改应用的描述信息
URI
示例:product_type_list=[eks, hybrid]
PUT /api/ecns/${product type}/applications/<application_name>/
请求消息
application Type定义:
参数 | 参数类型 | 是否必选 | 描述 |
---|---|---|---|
name | str | 是 | 应用名称(唯一性校验) |
description | str | 否 | 应用描述 |
响应消息
参数 | 参数类型 | 描述 |
---|---|---|
application_info | application_info | 应用信息 |
应用详情
功能介绍
获取应用详情
URI
示例:product_type_list=[eks, hybrid]
GET /api/ecns/${product type}/applications/app/<application_name>/?type=<application_type>
| 参数 |参数类型| 是否必选 | 描述 |
| — |— |— | — |
| type | str |否 | 区分是混编应用还是普通容器应用,Normal / Hybrid,默认是Normal|
响应消息
参数 | 参数类型 | 描述 |
---|---|---|
application_info | application_info | 应用名称 |
application_info Type定义:
参数 | 参数类型 | 是否必选 | 描述 |
---|---|---|---|
application | application | 是 | application Type定义见前文 |
application_status | application_status | 是 | status均由后端返回,前端不填写 |
workloads_status | list(workload_status) | 是 | workload_status Type定义见后文 |
vms_status | list(vm_status) | 否 | 虚拟机工作负载状态,vm_status Type定义见后文 |
application_status Type定义:
参数 | 参数类型 | 是否必选 | 描述 |
---|---|---|---|
creation_time | str | 否 | |
status | str | 否 | No workload / Stopped / Unready / Running / Processing |
workload_status Type定义:
参数 | 参数类型 | 是否必选 | 描述 |
---|---|---|---|
workload_base | workload_base | 否 | |
owner | str | 是 | 工作负载所属应用 |
status | str | 是 | Runnning/Failed/Pending/Unknown/Succeed/Removing |
images | list(images) | 是 | 工作负载镜像列表 |
access_mode | list(access_mode) | 是 | 工作负载访问方式 |
ready_replicas | int | 是 | |
available_replicas | int | 否 | |
unavailable_replicas | int | 是 | |
creation_time | str | 是 | 工作负载创造时间 |
启动应用
功能详情
启动应用,支持批量操作
URI
示例:product_type_list=[eks, hybrid]
PUT /api/ecns/${product type}/applications/app/?action=start
请求消息
参数 | 参数类型 | 是否必选 | 描述 |
---|---|---|---|
applications | list(application) | 是 |
正常响应码
200 OK
重新部署应用
功能详情
重新部署应用,支持批量操作
URI
示例:product_type_list=[eks, hybrid]
PUT /api/ecns/${product type}/applications/app/?action=recreate
请求消息
参数 | 参数类型 | 是否必选 | 描述 |
---|---|---|---|
applications | list(application) | 是 |
正常响应码
200 OK
删除应用
功能详情
删除应用,支持批量操作
URI
示例:product_type_list=[eks, hybrid]
resource_type_list=[workload, service, all]
DELETE /api/ecns/${product type}/applications/app/?resource=${resource type list}
接口约束
当resource的health Type定义为workload时,关联workload资源将被删除
为service时,需同时指定workload(格式为resource=workload,service),才可以删除workload以及关联资源
当为all时,删除所有关联资源
请求消息
参数 | 参数类型 | 是否必选 | 描述 |
---|---|---|---|
applications | list(application) | 是 |
URL参数
参数 | 参数类型 | 是否必选 | 描述 |
---|---|---|---|
resource | str | 否 | 是否级联删除指定资源 |
正常响应码
404 Not Found